Introdução

Sobre

Esse documento contempla as orientações para realizar a integração de sistemas externos com a API REST da Plataforma EzPay Business.

Protocolo de Comunicação

O protocolo de comunicação utilizado é o REST com TLS - Representational State Transfer/ HTTP e os dados trafegados utilizam a notação JSON (JavaScript Object Notation).

Requisitos de Segurança

Autenticação via mTLS (Mutual TLS). O cliente deve apresentar um certificado digital válido durante o handshake TLS. O servidor valida o certificado em todas as solicitações para garantir a identidade do cliente (autenticação mútua).

Cada chamada aos serviços deve conter no header da requisição HTTP, a chave Authorization contendo no valor um token de acesso que identificará unicamente o sistema de origem e permitirá a confirmação da habilitação no acesso aos serviços permitidos.

O valor do token de acesso, na requisição, deve ser acrescido no prefixo Bearer com um espaço em branco, conforme o seguinte exemplo: Authorization: “Bearer valor_token”.

Dados sensíveis do JSON retornados pela API são criptografados utilizando o padrão JWE (JSON Web Encryption).

O primeiro passo para utilizar as APIs da EzPay Business é obter uma chave de acesso. O token de acesso deverá ser obtido através de cadastro prévio realizado pelo EzPay Business.

O certificado digital e a chave para descriptografar os dados sensíveis serão disponibilizados pela EzPay Business ao parceiro mediante contrato de serviços.