For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authentication

Os endpoints do MIDAPI v2 são autenticados com um token JWT de consumidor enviado no cabeçalho Authorization: Bearer <token>. O token é emitido a partir dos dois conceitos apresentados em MIDAPI v2: a plataforma do cliente emite tokens para seus consumidores, e cada chamada operacional é realizada em nome de um consumidor.

Cabeçalhos de identificação

Cabeçalho
Descrição

platform-id

Identifica a plataforma do cliente. Obrigatória apenas na emissão do token de consumer (POST /consumer/token).

platform-api-key

API key da plataforma do cliente. Obrigatória apenas na emissão do token de consumer (POST /consumer/token).

consumer-id

Identifica o canal/consumer. Obrigatória nos endpoints operacionais (/storage e /v2/daf/*).

Requisitos dos endpoints operacionais

Todos os endpoints de DAF exigem:

  • Autenticação OAuth2: cabeçalho Authorization: Bearer <token>, obtido por meio de POST /consumer/token (JWT assinado com RS256, veja abaixo).

  • Cabeçalho consumer-id: identificador do consumer. Obrigatório e não vazio.

  • Cabeçalho operation-id: identificador da operação/sessão de negócio. Obrigatória em POST /v2/daf/validate e na consulta de status GET /v2/daf/{transactionId}.

MIDAPI v2 não utiliza autenticação por x-api-key. O esquema é OAuth2 Bearer + consumer-id (e operation-id ao iniciar a validação e ao consultar o status).

Obter o token de consumer

Antes de invocar qualquer endpoint operacional, o consumer deve obter um token JWT e enviá-lo no cabeçalho Authorization: Bearer <token>. O token é emitido pela Facephi e inclui o consumer-id e os scopes correspondentes aos serviços habilitados para esse consumer.

Endpoint

POST /consumer/token

Cabeçalhos

Nome
Tipo
Obrigatório
Descrição

platform-id

string

Sim

Identificador da plataforma do cliente.

platform-api-key

string

Sim

API key da plataforma do cliente.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

consumerId

string

Sim

Identificador do consumer (canal ou vertical) para o qual o token é solicitado.

Exemplo de solicitação

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro
Tipo
Descrição

consumerId

string

Consumer para o qual o token foi emitido.

token

string

Token JWT a ser enviado no cabeçalho Authorization: Bearer <token>.

expiresAt

string

Data e hora de expiração do token no formato ISO 8601.

Exemplo de resposta

O token tem uma validade de 1 hora a partir de sua emissão (o instante exato de expiração é retornado no campo expiresAt). Uma vez expirado, basta solicitar um novo por meio do mesmo endpoint. Em cada requisição, são validados a assinatura, o emissor, o consumer-id, a expiração e os scopes do token.

Atualizado