Naar hoofdinhoud gaan
POST
/
v1
/
schedules
Maak Schema
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"
}

Autorisaties

​
Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waarbij jouw auth token is.

Body

application/json
​
method
enum<string>
vereist

HTTP-methode voor de geplande API-aanroep. Moet GET of POST zijn.

Beschikbare opties:
GET,
POST
​
endpoint
string
vereist

De endpoint-URL om aan te roepen wanneer het schema wordt uitgevoerd. Voor POST-verzoeken met Olostep-eindpunten kun je korte vorm gebruiken (bijv. 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers') die automatisch worden geprefixed met 'https://api.olostep.com/'. Voor andere eindpunten, geef de volledige URL op.

​
payload
object

De payload om mee te sturen met de API-aanroep. Kan elke JSON-structuur bevatten die je nodig hebt. Voor GET-verzoeken is dit meestal leeg. Voor POST-verzoeken moet dit de gegevens bevatten die je naar het eindpunt wilt verzenden.

​
cron_expression
string

Cron-expressie in 6 velden formaat (minuut uur dag maand dag-van-de-week jaar) voor terugkerende schema's. Vereist voor terugkerende schema's. Wederzijds exclusief met execute_at en text.

​
execute_at
string<date-time>

ISO 8601 datetime string voor eenmalige schema-uitvoering. Moet een geldige toekomstige datetime zijn. Vereist voor eenmalige schema's. Wederzijds exclusief met cron_expression.

​
expression_timezone
string

IANA tijdzone-identificator (bijv. 'UTC', 'America/New_York', 'Europe/London') voor het schema. Vereist voor terugkerende schema's, optioneel voor eenmalige schema's. Bij gebruik van natuurlijke taaltekst is de standaard 'UTC'.

​
text
string

Natuurlijke taaltekst om automatisch een cron-expressie te genereren. Het systeem zal je tekst omzetten in een geldige cron-expressie. Voorbeelden: 'elke 3 minuten', 'elke dag om 10 uur', 'elke maandag om 9 uur'. Wederzijds exclusief met cron_expression en execute_at. Bij gebruik is expression_timezone standaard 'UTC'.

Respons

Schema succesvol aangemaakt.

​
id
string

Unieke schema-identificator

​
type
enum<string>

Type schema: 'recurring' voor cron-gebaseerde schema's, 'onetime' voor eenmalige uitvoeringsschema's

Beschikbare opties:
recurring,
onetime
​
method
enum<string>

HTTP-methode voor de geplande aanroep

Beschikbare opties:
GET,
POST
​
endpoint
string

De endpoint-URL die zal worden aangeroepen

​
cron_expression
string

Cron-expressie (alleen aanwezig voor terugkerende schema's)

​
execute_at
string<date-time>

Uitvoeringsdatetime (alleen aanwezig voor eenmalige schema's)

​
expression_timezone
string

Tijdzone voor het schema

​
created
string<date-time>

ISO 8601 datetime wanneer het schema is aangemaakt