Guias
GuiasReferência de API

Chaves de Acesso

Para realizar as chamadas na API de Baas é preciso configurar suas chaves de acesso. Nós disponibilizamos dois tipos de chave secreta, uma para o ambiente de teste e outra para o ambiente de produção, como descritos na tabela abaixo:

AmbienteTipo de chaveQuando usar
TesteChave privada, vinculada a sua aplicação na Plataforma Baas e disponibilizada no modo teste.
⚠️ As informações armazenados são dados sensíveis. Mantenha sua chave em sigilo e não a compartilhe com ninguém.
Disponibilizado para criação e implementação da integração. Nele, podem ser feitos testes para analisar o código e entender as funcionalidades a partir de transações que não processão recebíveis reais.
ProduçãoChave privada, vinculada a sua aplicação na Plataforma Baas e e disponibilizada no modo de produção.
⚠️ As informações armazenados são dados sensíveis. Mantenha sua chave em sigilo e não a compartilhe com ninguém.
Este modo deve ser ativado quando o parceiro estiver pronto para lançar o produto e a homologação for aprovada.
📘 Neste ambiente são geradas transações com dados reais vinculados aos clientes.

~~Ambas estão disponíveis na nossa plataforma de suporte e gerenciamento, consulte a guia Plataforma BaaS para saber mais sobre ela. (link para a pág de plataforma na Api).

Para acessar sua chave na Plataforma é necessário:

  1. Acessar a Plataforma
  2. Fazer o cadastro na Plataforma Baas
  3. Criar uma aplicação OU aceitar um convite de acesso.
  4. Consultar sua chave de API secreta.

📘

Permissionamento de chaves

Dependendo da demanda do cliente as chaves disponibilizadas na plataforma Baas podem ter permissões personalizadas, ou seja, acessar apenas alguns endpoints da API. Para saber mais
entre em contato com a nossa equipe de suporte.

Com a chave revelada, é necessário autenticar as chamadas realizadas na API de Baas, para isso deve-se:

  1. Acessar o Postman, por exemplo.
  2. Enviar um parâmetro X-API-KEY no header das requisições da API de BaaS.
  3. Se os parâmetros enviados estiverem corretos vc receberá uma resposta de status 200 - ok

Agora, para completar as medidas de segurança obrigatórias da API de BaaS, é necessário emitir um certificado mTLR para o ambiente de teste e outro para o ambiente de produção.


What’s Next