Passar para o conteúdo principal

Como testar a integração com a API no ambiente de teste

Como usar uma chave de teste para chamar a API da Kamino com dados de exemplo, antes de ligar a integração aos dados reais.

C
Escrito por Customer Success

O ambiente de teste da API tem dados fictícios, com o mesmo formato dos reais. A integração é construída e testada nele, com uma chave de teste, e só depois passa para a chave de produção.

O que é o ambiente de teste da API

  • Dados fictícios: dois grupos de exemplo, Matriz Teste e Filial Teste, com contas a receber e a pagar de exemplo. Nada vem dos dados reais da sua conta.

  • O mesmo contrato da produção: as mesmas rotas, os mesmos campos, a mesma paginação e os mesmos limites.

  • Endereço: o mesmo da produção com /test na frente da rota: https://developers.kamino.com.br/test/api/v1/….

Passo a passo para testar a integração no ambiente de teste

  1. Em Configurações › Integrações › Chaves de API, clique em Nova chave.

  2. Em Ambiente, escolha Teste. O segredo da chave de teste começa com pak_test_.

  3. Preencha o resto da chave e clique em Criar chave. Veja "Como criar, acompanhar e revogar uma chave de API".

  4. Copie o segredo e chame uma rota de teste, por exemplo GET https://developers.kamino.com.br/test/api/v1/receivables?size=1, com o cabeçalho Authorization: Bearer pak_test_SUA_CHAVE.

O painel Nova chave de API, com o ambiente Teste destacado

Sem chave, dá para testar pela documentação da API: o botão Testar de cada rota chama o ambiente de teste com o seu acesso. Veja "Como fazer a primeira chamada à API pela documentação".

Regras do ambiente de teste da API

  • Chave e rota precisam ser do mesmo ambiente. Chave de teste numa rota de produção, ou o contrário, recebe 401 environment_mismatch.

  • O ambiente de teste nasce com a primeira chave de teste. Enquanto ele é preparado, a API responde 503 sandbox_unavailable: espere os segundos do cabeçalho Retry-After e repita.

  • O limite de chamadas conta separado em teste e em produção.

  • Escritas no teste ficam só no teste. Nada sai do ambiente de teste.

  • Empresa e arquivamento: companyId vem preenchido, e archived=only devolve os títulos arquivados pelas chamadas de escrita, como na produção.

  • Diferença do teste: updatedSince é validado, mas todos os registros voltam.

Perguntas frequentes sobre o ambiente de teste da API

Posso usar a mesma chave no teste e na produção?

Não. Cada chave é de um ambiente. Crie uma chave de produção quando a integração estiver pronta.

Os dados de teste são da minha empresa?

Não. Os dados do ambiente de teste são fictícios, e nada é copiado da produção.

Respondeu à sua pergunta?

Artigos relacionados