Servicio de creación de edición de programas
El consumo de este servicio es obligatorio en el flujo de edición de horarios. Como resultado de esta operación, el comerciante obtendrá un SEID que será necesario para el siguiente paso del flujo.
SEID tiene un límite de tiempo para su uso. Este plazo se configura en Portal Carat, y si se excede, la transacción de edición cambiará del estado NOV (nuevo) a EXP (vencido), lo que impide futuras operaciones con esta transacción, por lo que es necesario consumir el servicio de nuevo Edición de creación.
Detalles de la llamada#
- Recurso:
/v1/schedules/edits - Método HTTP:
POST - Formato de solicitud:
JSON - Formato de respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
merchant_id | Código de tienda en Pago en Online. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI |
merchant_key | Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. | < 80 AN | SI |
Content-Type | Debe enviarse con el valor application / json. | = 15 AN | SI |
Ejemplo#
A continuación se muestra un ejemplo de cómo llamar al servicio de creación de edición de horarios con la herramienta cURL.
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
POST de autenticación:
Respuesta:
Parámetros de solicitud#
En la siguiente tabla se muestra la descripción de los parámetros de solicitud del servicio de creación de edición de programación:
| Parámetro | Descripción | Formato | Requerido |
|---|---|---|---|
| sid | Programar identificador para ser editado. | = 64 AN | SI |
| merchant_data | Datos generados por el comerciante que serán devueltos en el POST de autenticidad. Este campo se puede utilizar para ayudar a la tienda a identificar el origen de los POST de autenticidad recibidos. | < 20 AN | NO |
Parámetros de POST Autenticidad#
En la siguiente tabla, hay una descripción de los parámetros enviados por Portal Carat en el POST de autenticidad:
| Parámetro | Descripción | Formato |
|---|---|---|
| seid | Identificador de la edición del cronograma que se utilizará en el siguiente paso del flujo. | = 64 AN |
| sid | Programar identificador para ser editado. | = 64 AN |
| merchant_data | Datos generados por el comerciante que serán devueltos en el POST de autenticidad. Este campo se puede utilizar para ayudar a la tienda a identificar el origen de los POST de autenticidad recibidos. | < 20 AN |
Pago Online también puede enviar nuevos parámetros sin previo aviso, lo que significa que la aplicación de la tienda debe estar preparada para recibir campos adicionales y simplemente ignorarlos.
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "201". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de creación de edición de horarios:
| Parámetro | Descripción | Formato |
|---|---|---|
code | Código de respuesta de Portal Carat. Cualquier código que no sea "0" (cero) significa falla. [Más información.] (codigos-da-api.md#codigos-de-respuesta) | < 4 N |
message | Mensaje de respuesta de Portal Carat. | < 500 AN |