Pular para o conteúdo

Dicas e pontos importantes

Usar a API ajuda pode ter muitos benefícios para você, e aqui listamos algumas dicas para você e seu time de T.I. a fim de tornar esta experiência mais fluída. Para este artigo, assumimos que você já leu o artigo sobre autenticação e geração de chaves! 🙂

Use o sistema (via interface) antes de automatizar atividades

Algo que será muito importante é que você conheça as regras de negócio antes de tentar consumir as APIs. Se você quer emitir notas fiscais via API, saiba emitir notas fiscais via interface antes de começar. Isso facilitará o seu entendimento sobre os pré-requisitos de cada etapa, e também a tratativa de erros. Também, isso evitará que a falta de parametrização “entre no seu caminho” enquanto você tenta automatizar um processo.

A regra aqui é simples: automatize o que você já fez funcionar manualmente. 🙂

Entenda o fluxo e evite “tentativas e erros”

O Nimbly é um software complexo, com operações que envolvem múltiplas etapas (por exemplo: para emitir uma nota fiscal, é preciso configurar uma tabela de impostos, cadastrar a nota fiscal e aprová-la). Aprenda o fluxo completo e garanta que você tem todas as informações do seu lado antes de começar a consumir a API “até acertar”.

Nunca divulgue as chaves (ou: cuidado com o JavaScript!)

As chaves de acesso (hash e tokens) não devem ser divulgados em hipótese alguma. Por isso, você jamais deve consumir a API via javascript ou outra linguagem aberta ao usuário. Caso você precise fazer uma operação em Ajax, implemente do a requisição no seu backend, e consuma o seu próprio endpoint para realizar a chamada.

Use nossa SDK (.NET)

Caso você utilize .NET, você pode usar nossa SDK para consumir nossos métodos em sua aplicação. : )

Próxima Exemplo: consumindo a API via PowerShell
Sumário