Informações gerais

Sabia tudo sobre os ambientes, autenticação e formatos

Ambientes / Hosts

A Blue Fleet possui infraestrutura completamente separada para os ambientes de Sandbox e Produção.

O ambiente de Sandbox foi criado para os desenvolvedores realizarem seus testes, validações e integração. Quando tudo estiver pronto e homologado, apenas as variáveis de Host e Access Token precisarão ser atualizadas para o ambiente de produção.

Os ambientes estão sempre na mesma versão, portanto quando ocorre uma atualização em Produção, a mesma atualização ocorre no ambiente Sandbox.

AMBIENTE	HOST
Produção	https://api.bluefleet.com.br
Sandbox	https://api.qa.bluefleet.com.br

Autenticação

A API da Blue Fleet utiliza o padrão de autenticação OAuth2.0 com Client Credentials.

É desejável que você possua conhecimento prévio do protocolo de autenticação OAuth2.0 com Cliente Credentials: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials

Para realizar a autenticação você deve obter previamente o client_id e client_secret para utilização da API. Caso não possua estes dados, solicite para equipe de suporte através do e-mail [email protected].

A geração do token deve ser inicialmente autenticada com Basic Access Authentication Basic access authentication, e feita a partir de uma requisição https via método POST no endereço abaixo:

AMBIENTE	URL
Produção	https://auth.bluefleet.com.br/connect/token
Sandbox	https://auth.qa.bluefleet.com.br/connect/token

Geração do Basic Authentication Token

Para gerar um token de autenticação, é necessário codificar o client_id e o client_secret em BASE64, seguindo o formato abaixo:

token = base64_encode(client_id + ':' + client_secret)

Exemplo de obtenção de token

POST https://auth.bluefleet.com.br/connect/tokenHeaders:Accept: application/jsonAuthorization: Basic <BASE64_ENCODED_TOKEN>Content-Type: application/x-www-form-urlencodedBody:grant_type=client_credentials

Abaixo um exemplo de um request em cURL:

curl --location 'https://auth.bluefleet.com.br/connect/token' \
--header 'Authorization: Basic <BASE64_ENCODED_TOKEN>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'

Obtenha um client_id e client_secret válidos enviando um e-mail para [email protected]

O resultado desta requisição será um JWT Access Token que deverá ser utilizado nas chamadas da API.

{
    "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjMyMUUzMzk1MTc3RkY4REU4RTg4NkU0Qzk3MUM4RDZFIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2ODQxNjI5OTUsImV4cCI6MTY4NDE2NjU5NSwiaXNzIjoiaHR0cHM6Ly9hdXRoLnFhLmJsdWVmbGVldC5jb20uYnIiLCJhdWQiOiJiZi1wdWJsaWMtYXBpIiwiY2xpZW50X2lkIjoiNGRlY2IwNmYtNmNmMi00NTdmLWIwZGUtMGI1OTI3ZDZjYzZlIiwiY2xpZW50X3VzZXJfaWQiOiIxMjYzNyIsImp0aSI6Ijc2RjVBRUNGQjE2OTZGQTBGNDA2RTIzQzIwQ0U0QjhCIiwiaWF0IjoxNjg0MTYyOTk1LCJzY29wZSI6WyJiZi1wdWJsaWMtYXBpIl19.msx5wAT7KS1Q2WWh3NDwN_caBc7FBX_0waQdRfbLW4_5YRmic4ZfRShCJaIbmPGcMzKG8FK0tbRBFInZrAXBxtcIzI-fere5Ns7yvfCnhXN_4Bv_7-5qz9ovWFqIkqo3rn1gIQGhUR8mpawTl1QzBIQ3J64SRoUTiE5JTjpmfx3HlOgBCSz9Ucw04v3wIYMEdCrH_uryy3flUR6gjKeWlZumEiw4VHeBQDTDnOzH49qBNd4ycu9S0bfFWr-kwGCvBoPswKnHqqcb7p7tFoz51QIfWlYV3PdyWDWkxWg4LFoLFF-ZIDUdwZzt1D7HYdFvhcY_j7anYJ8zlYocXKZHXA",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "bf-public-api"
}

Por padrão o Access Token expira em uma hora. Após este período um novo Access Token deve ser gerado.

Formatação de datas

Para padronização, todas as datas devem ser formatadas de acordo com a norma ISO 8601, por exemplo:

2022-09-10T18:32:10.335-03:00

As respostas das requisições sempre estarão no fuso horário UTC.