Pular para o conteúdo principal

Autenticação

POST [Url Ambiente]/api/auth/token

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json

Body

ParâmetroDescriçãoTipoExemplosObrigatório
grant_typeTipo de concessãoString"client_credentials"Sim
client_idIdentificador do cliente fornecido pela AcertPixString"104s3a5275a0d35e4"Sim
client_secretChave secreta do cliente fornecida pela AcertPixString"e15148d497d8bc12"Sim
scopeEscopo de acesso (opcional)String"api"Não

Exemplo

{
"grant_type": "client_credentials",
"client_id": "104s3a5275a0d35e4",
"client_secret": "e15148d497d8bc12",
"scope": "api"
}

Exemplo CURL

curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"grant_type": "client_credentials",
"client_id": "104s3a5275a0d35e4",
"client_secret": "e15148d497d8bc12",
"scope": "api"
}' \
'https://api.evidencia.acertpix.com.br/api/auth/token'

Status Code 200

Autenticação realizada com sucesso.

ParâmetroDescriçãoTipoExemplos
access_tokenToken JWT para autenticação nas requisiçõesString"eyJhbGciOiJIUzI1NiIsInR5cCI6..."
token_typeTipo de tokenString"Bearer"
expires_inTempo de expiração em segundosInteger86400
issued_atData/hora de emissão do tokenString (ISO 8601)"2025-01-20T10:30:00Z"
expires_atData/hora de expiração do tokenString (ISO 8601)"2025-01-21T10:30:00Z"
scopeEscopo concedidoString"api"

Exemplo

{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbXByZXNhX2lkIjoiMTIzIiwiZW1wcmVzYV9ub21lIjoiRW1wcmVzYSBUZXN0ZSIsImVtcHJlc2FfY25waiI6IjEyMzQ1Njc4MDAwMTIzIiwiZ3J1cG9faWQiOiI0NSIsImNsaWVudF9pZCI6IjEwNHMzYTUyNzVhMGQzNWU0IiwibmJmIjoxNzM3MzY2NjAwLCJleHAiOjE3Mzc0NTMwMDAsImlhdCI6MTczNzM2NjYwMCwiaXNzIjoiRXZpZGVuY2lhQVBJIiwiYXVkIjoiRXZpZGVuY2lhQVBJIn0.7V_Kj9P2xQl8wFmE3nN1rT5yH6vX8sA4bC9dE0fG1hI",
"token_type": "Bearer",
"expires_in": 86400,
"issued_at": "2025-01-20T10:30:00Z",
"expires_at": "2025-01-21T10:30:00Z",
"scope": "api"
}

Status Code 400

Erro de validação nos dados da requisição.

ParâmetroDescriçãoTipoExemplos
errorCódigo de erroString"invalid_request"
error_descriptionDescrição detalhada do erroString"O parâmetro grant_type é obrigatório"

Exemplo

{
"error": "invalid_request",
"error_description": "O parâmetro grant_type é obrigatório"
}

Status Code 401

Credenciais inválidas ou expiradas.

ParâmetroDescriçãoTipoExemplos
errorCódigo de erroString"invalid_client"
error_descriptionDescrição detalhada do erroString"Client ID ou Client Secret inválidos"

Exemplo

{
"error": "invalid_client",
"error_description": "Client ID ou Client Secret inválidos"
}

Status Code 500

Erro interno do servidor.

ParâmetroDescriçãoTipoExemplos
errorCódigo de erroString"server_error"
error_descriptionDescrição detalhada do erroString"Erro ao processar autenticação"

Exemplo

{
"error": "server_error",
"error_description": "Erro ao processar autenticação"
}

Como Utilizar o Token

Após obter o token de acesso, você deve incluí-lo no header Authorization de todas as requisições à API:

Authorization: Bearer {access_token}

Exemplo Completo

curl -X GET \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
--header 'Accept: application/json' \
'https://api.evidencia.acertpix.com.br/api/analise/123'

Segurança

  • ⚠️ Nunca compartilhe suas credenciais (client_id e client_secret)
  • ⚠️ Não exponha o client_secret em código frontend ou repositórios públicos
  • ⚠️ Armazene as credenciais de forma segura (variáveis de ambiente, cofres de secrets)