Todas os endpoints da API são protegidos por autenticação, ou seja, precisamos identificar quem está fazendo a requisição para liberar o acesso. Para consumir os endpoints da plataforma é necessário passar uma API Key no cabeçalho da requisição.
O que é uma API Key ?
A API Key contém informações sobre o seu negócio, não fazendo distinção entre os seus usuários finais. Colocamos algumas informações do negócio e encriptamos usando um secret armazenado na nossa plataforma. Dessa forma ao recebermos a API Key em uma requisição, conseguimos identificar que ela foi previamente gerada por nós de forma segura e representa um negócio já cadastrado na plataforma.
Para obter a API KEY entre em contato com o suporte do time Labs.
Como acessar nossos endpoints usando a API Key ?
Recebemos a API Key de forma padronizada no header "x-api-key":
curl --location --request GET 'https://api-integration.v2.portalgera.com.br/utilities/fatura?referenciaInicio=2023-09-01' \
--header 'Content-Type: application/json' \
--header 'x-api-key: U2FxdGVkX5+NfNetcexJILF/RKVybwdPWJKBR/M9xeE='
Como funciona a integração entre sistemas usando API Key?
Suponha que temos um negócio chamado EnergiaEAlegria que gostaria de usar nossa plataforma para fazer consultas de unidades consumidoras.
O time técnico do EnergiaEAlegria obtém uma API Key com o suporte Labs para integrar no seu sistema de gestão de energia.
Com a API Key configurada e o endpoint de consulta de unidades consumidoras integrado, é possível que um usuário titular de uma UC 22222 após fazer login no sistema EnergiaEAlegria consiga obter os dados de sua UC através da nossa API.
A API Key será integrada no fluxo de comunicação entre os 2 backends.
A gestão de usuários é feita inteiramente pela empresa EnergiaEAlegria e a integração com nosso sistema é feita de forma transparente sem que o usuário saiba que é nosso sistema que está fornecendo os dados.
A API Key deve ser mantida de forma segura, deve ficar guardada no backend do sistema consumidor e jamais ser exposta no frontend.