API Documentation - Authentication

Environment

Production: https://api.kestraa.com.br

QA: https://api-qa.kestraa.com.br

POST Authenticate

Authentication for using Kestraa platform services.

Target URL: ${environment}/login

Request

curl --location --request POST '${environment}/login' \
    --header 'Content-Type: application/json' \
    --data-raw '{
      "email": "test@client.com.br",
      "password": "kestraa_client"
    }'

Required Headers

Name	Description
Content-Type	Request content type (application/json).

Request Body

{
  "email": "test@client.com.br",
  "password": "kestraa_client"
}

Request Fields

Field	Description
email	User's email. (required)
password	User's access password. (required)

200 - Response

{
  "token": "...",
  "accessToken": "...",
  "refreshToken": "...",
  "user": "b7cb3aad-6738-41c2-a848-5e9356da5bd4"
}

Response Fields

Field	Description
token	Token generated on successful request for client API use.
accessToken	Token generated on successful request for backend-for-frontend (BFF) use.
refreshToken	Refresh token generated on successful request for BFF use.
user	External ID generated on successful request.

HTTP Status Codes

Code	Description
200	OK
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error