Como utilizar a API

Primeiros passos

Antes de começar utilizar as rotas da API, será necessário criar sua chave da API (API Key). Pode ser encontrada em Configurações > API.

Ao clicar em "+Gerar token de acesso", será exibido um formulário onde você poderá definir uma descrição, um usuário responsável e um prazo de expiração. Todos os campos são opcionais.

Utilizando a API Key

Para utilizar a chave da API, você deve incluí-la no cabeçalho da requisição (Header). Veja o exemplo abaixo:

https://api.nibo.com.br/accountant/api/v1/accountingfirms

IMPORTANTE: Para autenticar a requisição, inclua a API Key no cabeçalho. Se o token estiver vinculado a um usuário, apenas o header X-API-Key é necessário.

✅ - H "X-API-Key: 58524AE25524003BB0E4CD0B84B46A56"

IMPORTANTE: Se o token não estiver vinculado a um usuário, o header X-User-Id também é obrigatório. Você pode encontrar os IDs de usuário na rota de usuários.

✅ - H "X-API-Key: 58524AE25524003BB0E4CD0B84B46A56"

✅ - H "X-User-Id: 09887CB86A684638BBBA50023D90E3D1"

Utilizando o Metadata

Para obter informações sobre a totalizadores em uma consulta GET, inclua o seguinte header na sua requisição:

✅ - H "Metadata: *"

Quando o header é fornecido, a resposta da incluirá um objeto metadata com a seguinte estrutura:

"metadata": {
"totalAllItems": 1500,
"total": 45
}

totalAllItems : Representa o número total de registros da consulta.

total: Representa a quantidade de registros que correspondem aos critérios de filtro da consulta.