Serviço de criação de token
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 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
<ApiDoc method="post" path="/e-sitef/api/v1/token/merchants" />
- Recurso:
/v1/token/merchants - Método HTTP:
POST - Formato da resposta:
JSON - Parâmetros de cabeçalho:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
merchant_id | Código da loja no Carat. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes. | < 80 AN | SIM |
Exemplo
Requisição:
Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>
curl
--request POST "https://{{url}}/e-sitef/api/v1/token/merchants"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose
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
Resposta:
{
"response_code":0,
"response_message":"OK. Transaction successful."
}
<ResponseCodes />
Parâmetros do POST de autenticidade
Na tabela abaixo está a descrição dos parâmetros enviados pelo Carat no POST de autenticidade:
| Parâmetro | Descrição | Formato |
|---|---|---|
token | Token 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âmetro | Descrição | Formato |
|---|---|---|
response_code | Código de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais. | < 4 N |
response_message | Mensagem de resposta do Carat. | < 500 AN |