Esta página foi criada para ajudá-lo a começar a usar a API de maneira fácil e eficiente.
A API do Nibo está disponível para todos os clientes do Nibo Gestão Financeira do plano Premium e sua utilização é muito simples.
Primeiros passos
Antes de começar você vai precisar da sua chave de API (api token). Ela pode ser encontrada na sua Empresa > Mais opções > Configurações > API
.
Utilizando o token de acesso
Você deve informá-la no Header da sua requisição ou como um dos parâmetros da rota, como no exemplo abaixo.
https://api.nibo.com.br/empresas/v1/schedules/debit?apitoken=58524AE25524003BB0E4CD0B84B46A56
IMPORTANTE: Caso informe o ApiToken no Header, utilize o parâmetro ApiToken e não o Authorization.
✅ - H "ApiToken: 58524AE25524003BB0E4CD0B84B46A56"
❌ - H "Authorization: 58524AE25524003BB0E4CD0B84B46A56"
Consultas
As rotas da API do Nibo podem ser consultadas utilizando OData, que é um protocolo padronizado para simplificar o consumo de APIs REST. Para a maioria das consultas do Nibo, você vai precisar conhecer apenas os seguintes parâmetros:
- $filter
- $orderBy
- $skip
- $top
IMPORTANTE: Todas as consultas possuem um limite de 500 registros.
Filtro
Para filtrar as informações em uma rota, você deve utilizar o parâmetro $filter
. Veja este primeiro exemplo de uma consulta de Pagamentos em aberto com o filtro $filter=value le 100
, indicando valores iguais ou inferiores a 100,00:
https://api.nibo.com.br/empresas/v1/schedules/debit?$filter=value> le 100
Veja este outro exemplo de consulta de Pagamentos em aberto, utilizando mais de um filtro $filter=year(dueDate eq 2023) AND month(dueDate eq 10) AND startswith(stakeholder/name, 'Papelaria')
, indicando Ano 2023, Mês 10 e Nome do fornecedor começa com 'Papelaria'.
https://api.nibo.com.br/empresas/v1/schedules/debit?$filter=year(dueDate) eq 2023 AND month(dueDate) eq 10 AND startswith(stakeholder/name, 'Papelaria')
Paginação
Toda consulta (GET) retorna o parâmetro count
contendo o número de registros encontrados e você pode utilizar os parâmetros $top
, $skip
e $orderBy
(obrigatório) para realizar a paginação, até chegar ao final.
Neste exemplo, temos os parâmetros $top=10
, $skip=20
e $orderBy=dueDate
para indicar que o retorno deverá ser da terceira página, contendo10 itens por página e ordenado pela data de vencimento.
https://api.nibo.com.br/empresas/v1/schedules/debit?$orderby=dueDate&$skip=20&$top=10
IMPORTANTE: O parâmetro $orderBy é obrigatório para realizar a paginação.
Juntando tudo
Veja este exemplo de uma consulta de Recebimentos em aberto:
apitoken=58524AE25524003BB0E4CD0B84B46A56
- Token da API informado na URL$orderby=dueDate
- Ordenado pela data de vencimento$top=20
- Tamanho da página (20 itens)$skip=0
- Página 1 (não pulou itens de páginas anteriores)$filter=value le 200
- Valores iguais ou inferiores a 200,00
https://api.nibo.com.br/empresas/v1/schedules/debit?apitoken=58524AE25524003BB0E4CD0B84B46A56&$orderby=dueDate&$skip=0&$top=20&$filter=value le 200