Serviço de geração de token de autenticidade

import ApiDoc from '../../src/components/api-doc/ApiDoc'; import ResponseCodes from './codigos-de-resposta.md';

O consumo do serviço de geração de token é obrigatório em alguns fluxos de operações genéricas. Como resultado dessa operação, o lojista obterá um token pela URL de autenticidade que serão necessários para os próximos passos do fluxo.

Detalhes da chamada

<ApiDoc method="get" path="/e-sitef/api/v1/token" />

  • Recurso: /v1/token
  • Método HTTP: GET
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoTipoTamanhoObrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.AN< 15Sim
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.AN< 80Sim

Em seguida, o Carat irá enviar uma requisição POST HTTPS (x-www-form-urlencoded) para a URL cadastrada, este POST contém as informações necessárias para obter o token para ser utilizado nas operações genéricas.

Simulação de POST de autenticidade:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl -X POST \
  https://urlDeAutenticidadeDaLoja.com.br \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'cache-control: no-cache' \
  -d 'token=1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr

<ResponseCodes />

Atenção: É essencial que o site hospedado na URL de Autenticidade da loja receba o token de autenticidade e responda HTTP 200, pois isto é condição para que o Carat considere o sucesso deste POST.

Caso o POST de autenticidade tenha ocorrido com sucesso, o Carat responderá um código "responseCode": "0" para a requisição da loja.