Saltar al contenido principal
POST
/
v1
/
schedules
Crear Horario
curl --request POST \
  --url https://api.olostep.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "endpoint": "<string>",
  "payload": {},
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "text": "<string>"
}
'
{
  "id": "<string>",
  "type": "recurring",
  "method": "GET",
  "endpoint": "<string>",
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer del formato Bearer , donde es tu token de autenticación.

Cuerpo

application/json
​
method
enum<string>
requerido

Método HTTP para la llamada de API programada. Debe ser GET o POST.

Opciones disponibles:
GET,
POST
​
endpoint
string
requerido

La URL del endpoint a llamar cuando se ejecute el horario. Para solicitudes POST con endpoints de Olostep, puedes usar la forma corta (por ejemplo, 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers') que será automáticamente prefijada con 'https://api.olostep.com/'. Para otros endpoints, proporciona la URL completa.

​
payload
object

La carga útil para enviar con la llamada de API. Puede contener cualquier estructura JSON que necesites. Para solicitudes GET, esto suele estar vacío. Para solicitudes POST, esto debe contener los datos que quieres enviar al endpoint.

​
cron_expression
string

Expresión cron en formato de 6 campos (minuto hora día mes día-de-la-semana año) para horarios recurrentes. Requerido para horarios recurrentes. Mutuamente exclusivo con execute_at y text.

​
execute_at
string<date-time>

Cadena de fecha y hora ISO 8601 para la ejecución de un horario único. Debe ser una fecha y hora futura válida. Requerido para horarios únicos. Mutuamente exclusivo con cron_expression.

​
expression_timezone
string

Identificador de zona horaria IANA (por ejemplo, 'UTC', 'America/New_York', 'Europe/London') para el horario. Requerido para horarios recurrentes, opcional para horarios únicos. Al usar texto en lenguaje natural, esto por defecto es 'UTC'.

​
text
string

Texto en lenguaje natural para generar automáticamente una expresión cron. El sistema convertirá tu texto en una expresión cron válida. Ejemplos: 'cada 3 minutos', 'todos los días a las 10am', 'todos los lunes a las 9am'. Mutuamente exclusivo con cron_expression y execute_at. Cuando se usa, expression_timezone por defecto es 'UTC'.

Respuesta

Horario creado exitosamente.

​
id
string

Identificador único del horario

​
type
enum<string>

Tipo de horario: 'recurring' para horarios basados en cron, 'onetime' para horarios de ejecución única

Opciones disponibles:
recurring,
onetime
​
method
enum<string>

Método HTTP para la llamada programada

Opciones disponibles:
GET,
POST
​
endpoint
string

La URL del endpoint que será llamada

​
cron_expression
string

Expresión cron (solo presente para horarios recurrentes)

​
execute_at
string<date-time>

Fecha y hora de ejecución (solo presente para horarios únicos)

​
expression_timezone
string

Zona horaria para el horario

​
created
string<date-time>

Fecha y hora ISO 8601 cuando el horario fue creado