Quick start

Este guia mostra o processo de edição de um agendamento, utilizando a interface web service REST do Carat.

O que você precisará#

SID de um agendamento com status ATV ou INA no Carat. Saiba mais.
Uma ferramenta capaz de realizar chamadas HTTP, como Postman, REST Client ou cURL
Uma aplicação capaz de receber chamadas POST HTTPS

Criando uma edição de agendamento#

Tipo de requisição: POST

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/edits

Headers:

Content-Type: application/json
merchant_id: {seu código de loja}
merchant_key: {chave da sua loja}

Requisição: Preencha o campo <sid> na requisição abaixo com o SID do agendamento a ser alterado.

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

{
  "sid": "<sid>",
  "merchant_data": "14114532781"
}

curl
--request POST "https://{{url}}/e-sitef/api/v1/schedules/edits"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "sid":"<sid>",
   "merchant_data":"14114532781"
}
--verbose

Recebimento do POST de autenticidade:

@RestController
public class MyAuthenticityController {

    @PostMapping(value = "/myauthenticity",
        consumes = "application/x-www-form-urlencoded; charset=utf-8")
    public ResponseEntity<String> myAuthenticity(@RequestParam Map<String, String> request) {
        Log.info("seid = " + request.get("seid"));
        // ...
        // armazena o SEID da edição de agendamento
        // ...
        return new ResponseEntity<>("OK", HttpStatus.OK);
    }

}

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful."
}

Saiba mais sobre esse serviço.

Alterando o agendamento#

Tipo de requisição: PUT

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/edits/<seid>

Preencha o campo <seid> na URL acima com o SEID obtido no POST de autenticidade.