Quick start

Esta guía muestra el proceso de edición de un horario, utilizando la interfaz del servicio web REST de Portal Carat.

Que necesitarás#

SID de una cita con estado ATV o INA en el Portal Carat. [Más información] (schedule-rest-quickstart.md)
Una herramienta capaz de realizar llamadas HTTP, como Postman, REST Client o cURL
Una aplicación capaz de recibir llamadas POST HTTPS

Creación de un horario de edición#

Tipo de solicitud : POST

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

Headers:

Content-Type:aplicación / json
merchant_id:{su código de tienda}
merchant_key:{la clave de tu tienda}

Solicitud: Complete el campo <sid > en la solicitud a continuación con el SID del horario que se cambiará.

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

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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

Recibo de autenticidad 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"));
        // ...
        // almacena el SEID de la edición de la agenda
        // ...
        return new ResponseEntity<>("OK", HttpStatus.OK);
    }

}

Respuesta:

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

Obtenga más información sobre este servicio.

Cambiar el horario#

Tipo de requisição: PUT

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

Complete el campo <seid > en la URL anterior con el SEID obtenido del POST de autenticidad.

Headers:

Content-Type: application/json
merchant_id: {su código de la tienda}
merchant_key: {clave de su tienda}

Solicitud:

{
  "status": "INA"
}

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/edits/<seid>"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "status":"INA"
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "schedule": {
    "status": "INA",
    "amount": "1",
    "next_date": "03/08/2025",
    "number_of_times": "3",
    "current_times": "0",
    "soft_descriptor": "Assinatura",
    "show_times_invoice": "false"
  },
  "schedule_edit": {
    "status": "CON"
  }
}

Más información sobre este servicio.

Home

Que necesitarás#

Creación de un horario de edición#

Cambiar el horario#