Passar para o conteúdo principal

Documentação da API: como acessar, obter a senha e gerar o token

Onde fica a documentação da API da Kamino, por que o link pede senha, como conseguir a senha e onde gerar a chave (token) de API do seu usuário.

M
Escrito por Marketing

A API da Kamino permite que outro sistema, como um ERP, um BI ou um sistema próprio da sua empresa, envie e consulte dados na Kamino sem digitação manual. Quem monta essa integração é o time técnico ou o desenvolvedor contratado, e tudo o que essa pessoa precisa está na documentação da API.

Para entender o que é uma API e os principais casos de uso, veja API - Kamino.

Como acessar a documentação

A documentação fica em kamino.readme.io. Ao abrir o link, a página pede uma senha.

A senha é a mesma para todos os clientes e é enviada pelo nosso atendimento. Peça pelo chat informando que precisa da senha da documentação da API.

Atenção: a senha abre só a documentação. Para acessar os dados da sua empresa, a integração precisa de uma chave de API gerada por um usuário da Kamino, como explicado abaixo.

Como gerar a chave da API

A chave de API é a credencial que a integração usa para acessar a Kamino em nome de um usuário. Só o próprio usuário consegue gerar as chaves dele, então entre na Kamino com o usuário para o qual você quer gerar a credencial.

Antes de começar: crie o aplicativo

A chave é sempre vinculada a um aplicativo. Se você ainda não criou o aplicativo da integração, crie primeiro em Configurar > Sistema > Aplicativos (API). O passo a passo está na página Getting started da documentação.

Passo a passo - Criar chave

  1. Acesse a Kamino com o seu próprio usuário.

  2. Vá em Configurar > Sistema > Usuários.

  3. Localize o seu usuário e clique nos três pontinhos ao lado do nome.

  4. Selecione Gerar Chave da API.

  5. Escolha o aplicativo que você criou.

  6. Clique em Gerar Chave.

As chaves aparecem na tela. Para copiar, passe o mouse sobre cada valor e clique no ícone de copiar.

Dica: recomendamos criar um usuário só para a API, com as permissões necessárias para as operações da integração. Assim fica fácil diferenciar o que foi feito pela API do que foi feito por uma pessoa no software.

Dúvidas frequentes

Consigo consultar o extrato da conta Kamino pela API?

Sim. Use o endpoint GET /api/financial/bankStatement/list, informando a conta, o período e os filtros. O identificador da conta (IDPlanoContaAtivo) vem do endpoint Listar classificações e contas.

O endpoint Importar transações do extrato faz o caminho contrário: envia transações de outro sistema para o extrato da Kamino.

Consigo puxar as compras do cartão Kamino em tempo real?

A documentação não tem hoje um endpoint para consultar a compra no momento em que ela é feita. Depois que você concilia as compras e elas viram lançamentos de contas a pagar, esses lançamentos podem ser consultados pela API.

A integração não traz os dados esperados. O que envio ao atendimento?

Fale com o nosso atendimento pelo chat e informe:

  • o sistema que está integrando com a Kamino;

  • a requisição que está sendo feita (o comando curl ou o endpoint e os parâmetros), sem a chave de API;

  • um exemplo de lançamento que deveria ter vindo e não veio;

  • um print do retorno da API.

Respondeu à sua pergunta?