Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integração e requisitos para utilização

A integração exige:

  • Acesso de rede ao ambiente Billing correspondente.

  • Credenciais compatíveis com o tipo de operação.

  • Token de acesso válido para realizar operações protegidas.

  • Permissões adequadas para as funcionalidades que serão utilizadas.

Para autenticação de usuários, é necessário utilizar CPF e OTP obtido no aplicativo BirdID.

Para aplicações externas, são necessárias as credenciais client_id e client_secret.

Nas operações corporativas, a aplicação deve considerar o contexto da corporação selecionada e tratar os resultados paginados das consultas.

Nas operações de varejo, a aplicação externa precisa estar autorizada para acessar as funcionalidades disponibilizadas.

Segurança

O acesso às operações é controlado por mecanismos de autenticação e autorização, considerando as credenciais, os tokens de acesso, o contexto corporativo e as permissões atribuídas ao usuário ou à aplicação.

As respostas de erro podem contemplar situações como:

  • Falhas de autenticação.

  • Credenciais de cliente inválidas.

  • Usuário inexistente.

  • Tipo de usuário inválido.

As diretrizes específicas sobre TLS mínimo, criptografia em repouso, armazenamento e rotação de segredos, trilhas de auditoria, retenção de dados e certificações de segurança devem ser complementadas conforme a documentação técnica oficial.

Restrições e limitações

  • O tempo de vida solicitado para o token de autenticação de usuário não pode ultrapassar sete dias.

  • A consulta de usuários de varejo por corporação permite, no máximo, 500 registros por página.

  • A alteração do tipo de usuário de varejo aceita somente os tipos normal e trial.

  • Usuários inexistentes e tipos inválidos são tratados como erros pelas operações correspondentes.

Atualizado

Isto foi útil?