O portal de API do Kubo centraliza a documentação técnica da API, as credenciais de acesso e os endpoints disponíveis para integração.
Por meio do portal, é possível consultar a referência da API e testar endpoints diretamente pelo playground interativo.
Instruções
Solicitar acesso ao portal de documentação de API
O acesso à documentação de API é restrito a usuários previamente cadastrados. Para solicitar acesso, siga os passos abaixo:
-
Abra um chamado de suporte ao Kubo
Após a realização do cadastro, você receberá um e-mail com o assunto Bem-vindo ao Portal de APIs Kubo - Configure seu acesso, do destinatário Portal APIs Kubo LXP. -
Abra o e-mail recebido e clique no botão Ativar Minha Conta e Definir Senha
Por segurança, o link de ativação é válido por 24 horas. Caso o prazo expire, será necessário solicitar o reenvio do convite ao suporte. -
Na tela Ativar sua conta, insira uma senha de acesso com, no mínimo, 8 caracteres
-
Confirme a senha no campo abaixo
-
Clique no botão Salvar Senha e Acessar Portal
-
Informe seu e-mail e sua senha
-
Clique no botão Acessar Portal
Acessar o portal de documentação de API
Após ativar a conta, para acessar a documentação de API, siga os passos abaixo:
-
Acesse o portal de documentação de API
-
Clique no botão Acessar Portal no canto superior direito
-
Informe seu e-mail e sua senha
-
Clique no botão Acessar Portal
Após o login, será exibida a tela Visão Geral da API, com os endpoints disponíveis.
Também é possível navegar pelo menu lateral esquerdo para acessar um endpoint específico.
Realizar a autenticação
Antes de testar qualquer endpoint da API, recomendamos realizar a autenticação:
-
No menu lateral esquerdo, clique em AUTENTICAÇÃO
-
Clique no endpoint POST Login (/v3/auth/login)
-
No campo senha, informa a senha de acesso ao portal de documentação de API
-
Clique no botão Try it out
Quando a autenticação for realizada com sucesso, o portal exibirá o status da requisição e o token retornado.
Após executar o endpoint de login com sucesso, o token é capturado e salvo na sessão. Com isso, os demais endpoints disponíveis no menu lateral esquerdo podem ser testados normalmente.
Para isso, acesse o endpoint desejado, informe os parâmetros solicitados, se houver, e clique no botão Try it out para executar a requisição.
O resultado será exibido na área RESPONSE, contendo o status da requisição e os dados retornados pela API.