🔐 API Bloquo: Autenticação

1. Visão Geral

A autenticação na API da Bloquo é realizada por meio de um token do tipo Bearer, gerado a partir das credenciais do cliente: clientId e clientSecret. Este token é obrigatório para acessar qualquer recurso protegido da API.

2. Endpoint de Autenticação

• Método: POST

• URL:
  https://staging-api.bloquo.io/api/v1/customer//users/authenticateApiClient

• Cabeçalhos necessários: Nenhum cabeçalho adicional é necessário neste endpoint inicial.

3. Corpo da Requisição

Envie os dados em formato JSON:

json
{
  "clientId": "seu-client-id",
  "clientSecret": "seu-client-secret"
}

4. Exemplo de Requisição via cURL

bash
curl --location 'https://staging-api.bloquo.io/api/v1/customer//users/authenticateApiClient' \
--data '{
  "clientId": "seu-client-id",
  "clientSecret": "seu-client-secret"
}'

5. Exemplo de Resposta Bem-Sucedida

json
{
  "status": true,
  "statusCode": 200,
  "result": {
    "accessToken": "eyJraWQiOiJLY1NFWGF1T21SVzBFY...etc",
    "expiresIn": 3600,
    "tokenType": "Bearer"
  },
  "message": null
}

• accessToken: token de autenticação.

• expiresIn: tempo de expiração em segundos (ex: 3600 = 1 hora).

• tokenType: sempre Bearer.

6. Utilização do Token

Após obter o accessToken, você deve adicioná-lo como um cabeçalho Authorization nas requisições subsequentes da API:

Authorization: Bearer SEU_TOKEN_AQUI

7. Perguntas Frequentes (FAQ)

❓ O que é clientId e clientSecret?

São credenciais fornecidas pela Bloquo para autenticar sua aplicação. Se você não tiver, solicite ao suporte técnico da Bloquo.

❓ Onde coloco o token nas próximas chamadas da API?

Use o cabeçalho HTTP Authorization, precedido da palavra Bearer e um espaço:

http
Copy
Edit
Authorization: Bearer eyJraWQ...etc

❓ O token tem validade?

Sim. O campo expiresIn informa o tempo de validade em segundos (geralmente 3600 segundos = 1 hora). Após esse tempo, será necessário gerar um novo token.

❓ Posso usar o mesmo token em diferentes endpoints?

Sim, enquanto ele estiver válido. Após expirar, você deve autenticar novamente.

❓ O que significa o campo "status": true na resposta?

Indica que a autenticação foi realizada com sucesso.

❓ Qual ambiente essa URL representa?

A URL apresentada (staging-api.bloquo.io) refere-se ao ambiente de homologação. Para produção, consulte a equipe da Bloquo para obter o endpoint correto.

❓ Posso usar essa URL em produção?

Não. Esta é uma URL de staging (teste). Para produção, será necessário utilizar um endpoint apropriado e credenciais diferentes.

Se você ainda tiver dúvidas sobre a autenticação via API Bloquo, entre em contato com nosso time técnico ou consulte a documentação oficial.