Quick start

This guide shows the process of editing a schedule, using Carat Portal's REST web service interface.

What you'll need#

SID from a schedule with status ATV or INA on Carat Portal. Learn more.
A tool capable of performing HTTP calls, such as Postman, REST Client or cURL
An application capable of receiving POST HTTPS calls

Creating a schedule edit#

HTTP method: POST

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

Headers:

Content-Type: application/json
merchant_id: {your merchant id}
merchant_key: {your merchant key}

Request: Replace the <sid> field in the request below with the SID from the schedule to be altered.

To use this example, don't forget to define the variable {{url}} to the value
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

Receiving the authenticity POST:

@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"));
        // ...
        // stores the SEID of the schedule edit
        // ...
        return new ResponseEntity<>("OK", HttpStatus.OK);
    }

}

Response:

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

Learn more about this service.

Altering the schedule#

HTTP method: PUT

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

Replace the <seid> field in the URL above with the SEID obtained on the authenticity POST.