Vai al contenuto principale
POST
/
v1
/
schedules
Crea Programma
curl --request POST \
  --url https://api.olostep.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint": "<string>",
  "payload": {},
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "text": "<string>"
}
'
{
  "id": "<string>",
  "endpoint": "<string>",
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Autorizzazioni

​
Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer del tipo Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
​
method
enum<string>
obbligatorio

Metodo HTTP per la chiamata API programmata. Deve essere GET o POST.

Opzioni disponibili:
GET,
POST
​
endpoint
string
obbligatorio

L'URL dell'endpoint da chiamare quando il programma viene eseguito. Per le richieste POST con endpoint Olostep, puoi usare la forma breve (es., 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers') che verrà automaticamente prefissata con 'https://api.olostep.com/'. Per altri endpoint, fornisci l'URL completo.

​
payload
object

Il payload da inviare con la chiamata API. Può contenere qualsiasi struttura JSON di cui hai bisogno. Per le richieste GET, questo è tipicamente vuoto. Per le richieste POST, dovrebbe contenere i dati che vuoi inviare all'endpoint.

​
cron_expression
string

Espressione cron in formato a 6 campi (minuto ora giorno mese giorno-della-settimana anno) per programmi ricorrenti. Necessaria per programmi ricorrenti. Mutuamente esclusiva con execute_at e text.

​
execute_at
string<date-time>

Stringa datetime ISO 8601 per l'esecuzione di un programma una tantum. Deve essere un datetime futuro valido. Necessaria per programmi una tantum. Mutuamente esclusiva con cron_expression.

​
expression_timezone
string

Identificatore del fuso orario IANA (es., 'UTC', 'America/New_York', 'Europe/London') per il programma. Necessario per programmi ricorrenti, opzionale per programmi una tantum. Quando si utilizza testo in linguaggio naturale, il valore predefinito è 'UTC'.

​
text
string

Testo in linguaggio naturale per generare automaticamente un'espressione cron. Il sistema convertirà il tuo testo in un'espressione cron valida. Esempi: 'ogni 3 minuti', 'ogni giorno alle 10am', 'ogni lunedì alle 9am'. Mutuamente esclusivo con cron_expression e execute_at. Quando utilizzato, expression_timezone predefinito è 'UTC'.

Risposta

Programma creato con successo.

​
id
string

Identificatore univoco del programma

​
type
enum<string>

Tipo di programma: 'recurring' per programmi basati su cron, 'onetime' per programmi a esecuzione singola

Opzioni disponibili:
recurring,
onetime
​
method
enum<string>

Metodo HTTP per la chiamata programmata

Opzioni disponibili:
GET,
POST
​
endpoint
string

L'URL dell'endpoint che verrà chiamato

​
cron_expression
string

Espressione cron (presente solo per programmi ricorrenti)

​
execute_at
string<date-time>

Datetime di esecuzione (presente solo per programmi una tantum)

​
expression_timezone
string

Fuso orario per il programma

​
created
string<date-time>

Datetime ISO 8601 quando il programma è stato creato