Autenticação

Fluxo de autenticação da API de crédito da Grafeno.

Todas as requisições para a API de crédito da Grafeno são autenticadas via Bearer Token. O token é obtido a partir das suas credenciais de integração (client_id e client_secret) no endpoint de autorização e deve ser enviado no cabeçalho Authorization de cada chamada subsequente.

📘

Onde criar

As credenciais são criadas no Grafeno 360. Acesse o painel pelo endereço do ambiente em que você está integrando (desenvolvimento ou produção).

Criando uma nova chave de API

  1. No Grafeno 360, clique no nome da empresa, no canto superior direito da página.
  2. Selecione a opção Gestão de empresa.
  3. No menu lateral esquerdo, acesse Minha contaChaves de API.
  4. Clique em Criar nova chave.

Nomeando a chave

Ao clicar em Criar nova chave, será exibida uma janela solicitando um nome para a credencial:

Criar chave de API
Insira um nome descritivo para a sua nova chave de API. Isso ajudará a identificar o uso desta chave em futuras integrações.

Informe um nome descritivo, de preferência algo que indique onde ou por qual sistema a chave será usada (por exemplo, integracao-erp, ambiente-homologacao) e clique em Criar chave.

Credenciais geradas

Após a criação, o Grafeno 360 exibe a confirmação com as duas credenciais:

Chave de API criada com sucesso
Sua chave de API foi criada com sucesso. Agora você pode usá-la para acessar nossos serviços e recursos de integração.

Seu novo Client ID
Seu novo Client Secret

Exemplo do formato das credenciais:

Client ID:     00000000-0000-0000-0000-000000000000
Client Secret: 11111111-1111-1111-1111-111111111111

🚧

Importante

O client_secret é exibido apenas uma vez, no momento da criação. Depois de fechar essa tela, não é mais possível consultá-lo. Apenas o client_id permanece disponível para consulta.

Copie e armazene o client_secret em um local seguro (cofre de senhas, gerenciador de segredos, variáveis de ambiente). Caso ele seja perdido, será necessário criar uma nova chave.

Com o client_id e o client_secret em mãos, você já pode obter o token de acesso e começar a consumir a API.

O fluxo de criação do Bearer token é simples:

  1. Envie suas credenciais para o endpoint de autorização.
  2. Receba o access_token (Bearer Token) na resposta.
  3. Utilize esse token no cabeçalho Authorization: Bearer das demais requisições até que ele expire.

Endpoint

POST /auth/v1/authorize
AmbienteBase URL
Staginghttps://apis.stg.grafeno.be
Produçãohttps://apis.grafeno.digital

📘

Informação

As credenciais de staging e produção são distintas. Certifique-se de utilizar o par client_id / client_secret correspondente ao ambiente que está consumindo.

Cabeçalhos

CabeçalhoValorObrigatório
acceptapplication/jsonSim
content-typeapplication/jsonSim

Corpo da requisição

O corpo deve ser enviado em formato JSON com os seguintes campos:

  • client_id (string, obrigatório): Identificador único da sua aplicação/integração, fornecido pela Grafeno.
  • client_secret (string, obrigatório): Token secreto associado ao client_id. Deve ser mantido em segurança e nunca exposto no lado do cliente (front-end).
{
  "client_id": "SEU_CLIENT_ID",
  "client_secret": "SEU_SECRET_ID"
}

Exemplo de requisição

curl --request POST \
     --url https://portal-back.stg.grafeno.be/user/authorize \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
       "client_id": "SEU_CLIENT_ID",
       "client_secret": "SEU_SECRET_ID"
     }'

Exemplo de resposta

Em caso de sucesso, a API retorna o token de acesso a ser utilizado nas próximas requisições.

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Utilizando o token

Com o access_token em mãos, inclua-o no cabeçalho Authorization de todas as demais requisições, prefixado por Bearer:

curl --request GET \
     --url https://apis.stg.grafeno.be/laas/v2/{recurso} \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Erros comuns

CódigoSignificadoCausa provável
401 UnauthorizedCredenciais inválidasclient_id ou client_secret incorretos, revogados ou de outro ambiente.
400 Bad RequestRequisição malformadaCorpo JSON ausente, inválido ou com campos faltando.
403 ForbiddenSem permissãoCredenciais válidas, mas sem acesso ao recurso solicitado.

Boas práticas de segurança

  • Nunca exponha o client_secret em código front-end, repositórios públicos ou logs.
  • Realize a autenticação a partir de um serviço de back-end.
  • sempre renove o token a cada nova requisição.