Passer au contenu principal
POST
/
v1
/
schedules
Créer un Horaire
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"
}

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Corps

application/json
​
method
enum<string>
requis

Méthode HTTP pour l'appel API programmé. Doit être soit GET soit POST.

Options disponibles:
GET,
POST
​
endpoint
string
requis

L'URL du point de terminaison à appeler lorsque l'horaire s'exécute. Pour les requêtes POST avec des points de terminaison Olostep, tu peux utiliser la forme courte (par exemple, 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers') qui sera automatiquement préfixée par 'https://api.olostep.com/'. Pour d'autres points de terminaison, fournis l'URL complète.

​
payload
object

La charge utile à envoyer avec l'appel API. Peut contenir n'importe quelle structure JSON dont tu as besoin. Pour les requêtes GET, c'est généralement vide. Pour les requêtes POST, cela doit contenir les données que tu veux envoyer au point de terminaison.

​
cron_expression
string

Expression cron au format 6 champs (minute heure jour mois jour-de-la-semaine année) pour les horaires récurrents. Requis pour les horaires récurrents. Mutuellement exclusif avec execute_at et text.

​
execute_at
string<date-time>

Chaîne datetime ISO 8601 pour l'exécution d'un horaire unique. Doit être une datetime future valide. Requis pour les horaires uniques. Mutuellement exclusif avec cron_expression.

​
expression_timezone
string

Identifiant de fuseau horaire IANA (par exemple, 'UTC', 'America/New_York', 'Europe/London') pour l'horaire. Requis pour les horaires récurrents, optionnel pour les horaires uniques. Lors de l'utilisation de texte en langage naturel, cela par défaut est 'UTC'.

​
text
string

Texte en langage naturel pour générer automatiquement une expression cron. Le système convertira ton texte en une expression cron valide. Exemples : 'toutes les 3 minutes', 'tous les jours à 10h', 'tous les lundis à 9h'. Mutuellement exclusif avec cron_expression et execute_at. Lorsqu'il est utilisé, expression_timezone par défaut est 'UTC'.

Réponse

Horaire créé avec succès.

​
id
string

Identifiant unique de l'horaire

​
type
enum<string>

Type d'horaire : 'recurring' pour les horaires basés sur cron, 'onetime' pour les horaires d'exécution unique

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

Méthode HTTP pour l'appel programmé

Options disponibles:
GET,
POST
​
endpoint
string

L'URL du point de terminaison qui sera appelée

​
cron_expression
string

Expression cron (présente uniquement pour les horaires récurrents)

​
execute_at
string<date-time>

Date et heure d'exécution (présente uniquement pour les horaires uniques)

​
expression_timezone
string

Fuseau horaire pour l'horaire

​
created
string<date-time>

Chaîne datetime ISO 8601 lorsque l'horaire a été créé