Naar hoofdinhoud gaan
POST
/
v1
/
batches
Start een nieuwe batch
curl --request POST \
  --url https://api.olostep.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "custom_id": "product-123",
      "url": "https://example.com/product/123",
      "metadata": {
        "source": "catalog_sync",
        "priority": "high"
      }
    },
    {
      "custom_id": "product-456",
      "url": "https://example.com/product/456"
    }
  ],
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
'
{
  "id": "batch_abc123def456",
  "object": "batch",
  "status": "in_progress",
  "created": 1704067200,
  "total_urls": 2,
  "completed_urls": 0,
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
Word op de hoogte gebracht bij voltooiing: Geef de webhook parameter door met de URL van je eindpunt om een HTTP POST te ontvangen wanneer de batch voltooid is. Zie Webhooks voor details.
Voeg aangepaste data toe: Gebruik de metadata parameter om sleutel-waarde paren op te slaan. Ondersteund op twee niveaus:
  • Batch-niveau — in de request body
  • Item-niveau — op elk item in de items array
Zie Metadata voor details.

Autorisaties

​
Authorization
string
header
vereist

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

Body

application/json
​
items
object[]
vereist

Array van items die in de batch verwerkt moeten worden.

​
country
string

Land voor de batchuitvoering. Geef op in ISO 3166-1 alpha-2 codes zoals US(USA), IN(India), enz.

​
parser
object

Je kunt deze parameter gebruiken om de parser te specificeren die je wilt gebruiken. Parsers zijn handig om gestructureerde inhoud van webpagina's te extraheren. Olostep heeft een paar ingebouwde parsers voor de meest voorkomende webpagina's, en je kunt ook je eigen parsers maken.

​
links_on_page
object

Verkrijg alle links die aanwezig zijn op elke pagina in de batch.

​
metadata
object

Set van sleutel-waarde paren voor het opslaan van aanvullende informatie over een object. Volgt de aanpak van Stripe met validatieregels: maximaal 50 sleutels, sleutel maximaal 40 tekens (geen vierkante haken), waarde maximaal 500 tekens, alle waarden opgeslagen als strings.

Voorbeeld:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string<uri>

HTTPS URL om een POST-verzoek te ontvangen wanneer de batch voltooid is. Moet een openbaar toegankelijke URL zijn met gebruik van http:// of https:// protocol. Kan niet wijzen naar localhost of privé IP-adressen. Zie Webhooks voor payloadformaat en retry-gedrag.

Respons

Batch succesvol gestart.

​
id
string

Batch ID

​
object
string

Het soort object. "batch" voor dit eindpunt.

​
status
string

in_progress of completed

​
created
number

Gemaakt epoch

​
total_urls
number

Aantal URLs in de batch

​
completed_urls
number

Aantal voltooide URLs

​
parser
string
​
country
string
​
metadata
object

Set van sleutel-waarde paren voor het opslaan van aanvullende informatie over een object. Volgt de aanpak van Stripe met validatieregels: maximaal 50 sleutels, sleutel maximaal 40 tekens (geen vierkante haken), waarde maximaal 500 tekens, alle waarden opgeslagen als strings.

Voorbeeld:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string

Webhook URL om voltooiingsmelding te ontvangen