Criar e gerenciar APIs de integração

Criar uma API

1. 1

   Acesse Configuração > API.

2. 2

   Selecione Nova API.

3. 3

   Informe um nome que identifique o sistema ou a finalidade da integração.

4. 4

   Defina somente as permissões necessárias e confirme a criação.

5. 5

   Copie o token completo assim que ele for apresentado.

Guardar o token com segurança

• Use uma API diferente para cada sistema consumidor.
• Não compartilhe a mesma credencial entre produção, testes e desenvolvimento.
• Se houver suspeita de exposição, substitua a credencial e atualize a integração imediatamente.

Usar a documentação interativa

1. 1

   Abra a documentação disponível na página de APIs.

2. 2

   Escolha o grupo relacionado ao recurso que deseja integrar.

3. 3

   No sandbox, selecione a API criada para esse teste.

4. 4

   Informe o token somente no campo de autorização indicado.

5. 5

   Use a URL base mostrada pelo seu próprio ambiente e execute uma consulta sem efeito destrutivo para validar o acesso.

Manter a integração controlada

• Registre responsável, finalidade e sistema que utiliza cada API.
• Revise periodicamente credenciais sem uso e permissões maiores que o necessário.
• Consulte o log de auditoria ao investigar uso inesperado ou falhas recorrentes.
• Antes de remover ou substituir uma API, combine a troca com quem mantém o sistema consumidor.