Introdução

Nossas APIs oferecem os seguintes benefícios:

  • Comece agora: Visite nosso Portal do Desenvolvedor para descobrir o que nossas APIs fazem, como elas funcionam e o que você precisa fazer para interagir com elas. Use nossas sandboxes e comece a construir agora. Nossas APIs precisam de apenas algumas linhas de código para serem executadas em seus aplicativos.
  • Visão geral: Você sempre sabe o que está acontecendo. Use nossas análises de API para rastrear a atividade de seus usuários em seus aplicativos e ajustar suas táticas, se necessário.
  • Seja criativo: Estamos oferecendo a você a oportunidade de usar APIs exclusivas para ajudar a moldar o futuro dos serviços bancários.

O portal de desenvolvedores da API da Claro contém muitas informações sobre nossas APIs prontas para negócios. Reserve algum tempo para se familiarizar com o portal antes de começar a criar seus aplicativos.

Como Usar

Cadastro

Para usar nossos produtos API, basta criar uma conta de desenvolvedor.

Criar uma conta é rápido e fácil:

  • Clique em Inscreva-se.
  • Preencha o formulário com seus dados pessoais, incluindo seu nome, endereço de email e nome de usuário.
  • Envie o formulário.
  • Você receberá um email com um link de ativação. Clique no link e você está pronto para começar!

Explorar produtos API

Quer se inspirar e aprender o que você pode construir? Nossas APIs disponíveis são exibidas na página Produtos da API. A partir daqui, você pode navegar para as páginas subjacentes de Visão geral da API para obter detalhes de uma API específica. Em seguida, vá para as páginas da documentação para obter informações técnicas.

Como ir para o ambiente de produção

Depois de testar seu aplicativo e proposições relacionadas em nosso ambiente sandbox, você pode enviar uma solicitação para entrar em produção.

  • Primeiro, crie um novo aplicativo para produção. Ao fazer isso, você obterá uma chave de API diferente que poderá usar no seu ambiente de produção.
  • Para obter acesso à produção, é importante que os detalhes da sua conta e do aplicativo sejam registrados corretamente.
  • Assine os produtos da API que você deseja usar no ambiente de produção.
  • Envie sua solicitação e entre em contato para solicitar acesso à produção. Dependendo da API, nossa equipe de Serviços da API pode entrar em contato com você para discutir os detalhes de sua solicitação.
  • Depois de aprovado, você estará pronto para usar nossa API em um ambiente ativo.

Autenticação

A autenticação para esta API é feita com base no token de acesso. Para obter um token de acesso, você precisa chamar nossa API OAuth. O mecanismo de autenticação pode variar por API, dependendo do nível de autenticação necessário.

Ambientes

Esses são os URLs para os pontos de extremidade para obter os tokens.

Sandbox: https://auth-sandbox.connect.example.com

Produção: https://auth.connect.example.com

Fluxos de OAuth

Nossas APIs são protegidas usando o OAuth 2.0. Isso significa que você precisará passar um token de acesso ao fazer sua solicitação às APIs. Esta página explica como obter um token de acesso. Usamos os três fluxos a seguir para obter um token de acesso: credenciais do cliente, fluxo de código de autorização e token de atualização.

Se você quiser aprofundar alguns protocolos do OAuth, consulte o RFC do OAuth.

Tratamento de erros

Esta seção fornece uma visão geral do modelo de erro das APIs da Claro.

Formato de Erro

Todas as APIs da Claro geram erros no seguinte formato JSON:

{
	"errors": [
		{
			"code": "ERROR_UNIQUE_CODE",    
			"message": "ERROR_MESSAGE",
			"category" : "SHORT_DESCRIPTION/ERROR_CATEGORY",
			"reference" : "API_DOCUMENTATION_LINK",
			"status" : "HTTP_STATUS_CODE",
			"traceId" : "UUID"
			
		}
	]

}

Suporte

Dúvidas ou problemas? Estamos felizes em ajudar. Consulte nossa página de perguntas frequentes para obter respostas para as perguntas mais frequentes.

Não consegue encontrar a resposta que precisa? Entre em contato conosco e entraremos em contato o mais breve possível.

 
Falso