Serviço de criação de token

O consumo do serviço de geração de token é obrigatório para criar ou editar uma loja. Como resultado dessa operação, o lojista obterá um token pela sua URL de autenticidade que será necessário para o próximo passo do fluxo.

Detalhes da chamada#

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

Exemplo#

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/token/merchants"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

POST de autenticidade:

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

Resposta:

{
"response_code":0,
"response_message":"OK. Transaction successful."
}

Códigos de resposta

Veja a referencia no Códigos da API - códigos de resposta

Parâmetros do POST de autenticidade#

Na tabela abaixo está a descrição dos parâmetros enviados pelo Carat no POST de autenticidade:

ParâmetroDescriçãoFormato
tokenToken a ser utilizado na próxima etapa do fluxo.= 66 AN

O Carat também pode enviar novos parâmetros sem aviso prévio, o que significa que a aplicação do lojista deve estar preparada para receber campos extras e simplesmente ignorá-los.

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.

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de criação de token:

ParâmetroDescriçãoFormato
response_codeCódigo de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais.< 4 N
response_messageMensagem de resposta do Carat.< 500 AN