A API da Clara possibilita consultar transações, usuários, cartões e outras informações que se encontram dentro da sua Plataforma Clara.
Nossa API Clara é desenhada e construída seguindo princípios REST (Representational State Transfer), garantindo simplicidade e previsibilidade no desenvolvimento de aplicações.
Esta API adere aos padrões HTTP, garantindo compatibilidade com uma ampla gama de clientes HTTP. Você pode usar diversos clientes HTTP, incluindo linguagens de programação e frameworks, para interagir perfeitamente com nossa API.
Quais são os métodos e escopos disponíveis na API Clara?
A API Clara inclui os seguintes métodos:
- Transações: Read
- Usuários: Read
- Cartões: Read
- Grupos: Read
- Localidades: Read
Que tipo de autorização a API da Clara utiliza?
A API Clara incorpora um mecanismo de autenticação robusto que utiliza o OAuth 2.0 juntamente com o Mutual Transport Layer Security (mTLS). Isso garante o acesso seguro à API e protege seus dados valiosos. O processo de autenticação envolve as seguintes etapas essenciais:
1. Registro de Clientes
Antes de acessar a API da Clara, você precisa registrar sua aplicação cliente. Durante o registro, você fornece os detalhes de configuração necessários para autenticação.
2. Usuário do Projeto e Permissões
Após o registro da sua aplicação cliente, você pode criar usuários dentro do projeto e atribuir permissões específicas. Isso permite que você gerencie efetivamente os privilégios de acesso com base em diferentes funções de usuário.
3. Aquisição do Token
Para autenticar suas solicitações à API Clara, você deve adquirir um token. O token é obtido criando usuários por meio de nossa integração com o Auth0. Recupere o ID do token a partir da resposta da requisição, pois ele serve como chave para solicitações subsequentes à API.
4. Configuração de Certificado
Estabelecer uma conexão segura entre sua aplicação cliente e a API da Clara é essencial. Você pode fazer isso configurando sua aplicação cliente com os certificados gerados, incluindo as chaves pública e privada. Esses certificados possibilitam a autenticação mútua, reforçando a segurança do canal de comunicação.
5. Fluxo de Autenticação
Para iniciar o processo de autenticação utilize o ID do cliente, o segredo do cliente e outros parâmetros de login necessários. Em seguida, faça uma requisição do endpoint de autenticação definido, seguindo o fluxo do OAuth 2.0. Após uma autenticação bem-sucedida, a API gerará um token de acesso e fornecerá as credenciais associadas.
6. Recuperação Segura de Dados
Após obter o token de acesso, você pode recuperar dados com segurança da API da Clara. Requisite usando o método HTTP GET para os endpoints relevantes da API. Não se esqueça de incluir o token de acesso como um token do tipo bearer no header da requisição para autorizar o acesso e garantir a segurança dos dados.
Como posso obter acesso à API da Clara?
Você pode entrar em contato conosco solicitando seus acessos à API Clara pelo e-mail contato@clara.com e teremos prazer em ajudá-lo.
Os certificados que você receberá são:
- Certificado público para o cliente
- Certificado privado para o cliente
- Chave de token para o cliente
- Chave secreta do token
- Certificado público da autoridade certificadora da Clara
Quais permissões podem acessar a API da Clara?
As chaves da API podem ser gerenciadas apenas por usuário com permissão de proprietário.
🙋️ Precisa de ajuda? Fale com a gente.
📧️ contato@clara.com
💬️ Chat na Central de Ajuda ou em nossa plataforma