Serviço de criação de edição de agendamento
O consumo desse serviço é obrigatório no fluxo de edição de agendamento. Como resultado dessa operação, o lojista obterá um SEID que será necessário para o próximo passo do fluxo.
O SEID possui um tempo limite para sua utilização. Este prazo está configurado no Carat, e caso seja excedido, a transação de edição passará do status NOV (nova) para EXP (expirada), o que impede futuras operações com essa transação, tornando necessário consumir novamente o serviço de criação de edição.
Detalhes da chamada#
- Recurso:
/v1/schedules/edits - Método HTTP:
POST - Formato da requisição:
JSON - 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 |
Content-Type | Deve ser enviado com o valor application/json. | = 15 AN | SIM |
Exemplo#
Abaixo está um exemplo de chamada do serviço de criação de edição de agendamento utilizando a ferramenta cURL.
Requisição:
Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br
POST de autenticidade:
Resposta:
Parâmetros de requisição#
Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de criação de edição de agendamento:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
| sid | Identificador do agendamento a ser editado. | = 64 AN | SIM |
| merchant_data | Dados gerados pelo lojista que serão retornados no POST de autenticidade. Este campo pode ser utilizado para ajudar a loja a identificar a origem dos POSTs de autenticidade recebidos. | < 20 AN | NÃO |
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 |
|---|---|---|
| seid | Identificador da edição de agendamento a ser utilizado na próxima etapa do fluxo. | = 64 AN |
| sid | Identificador do agendamento a ser alterado. | = 64 AN |
| merchant_data | Dados enviados pelo lojista para ajudar a identificar a origem do POST de autenticidade. | < 20 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.
Parâmetros de resposta#
Em caso de sucesso, o código de resposta HTTP será 201. 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 edição de agendamento:
| Parâmetro | Descrição | Formato |
|---|---|---|
code | Código de resposta do Carat. Qualquer código diferente de 0(zero) significa falha. Saiba mais. | < 4 N |
message | Mensagem de resposta do Carat. | < 500 AN |