Passer au contenu principal
POST
/
v1
/
batches
Démarrer un nouveau lot
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"
  }
}
Soyez notifié à la fin : Passez le paramètre webhook avec l’URL de votre point de terminaison pour recevoir un HTTP POST lorsque le lot est terminé. Voir Webhooks pour plus de détails.
Joindre des données personnalisées : Utilisez le paramètre metadata pour stocker des paires clé-valeur. Pris en charge à deux niveaux :
  • Niveau du lot — dans le corps de la requête
  • Niveau de l’élément — sur chaque élément dans le tableau items
Voir Métadonnées pour plus de détails.

Autorisations

​
Authorization
string
header
requis

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

Corps

application/json
​
items
object[]
requis

Tableau d'éléments à traiter dans le lot.

​
country
string

Pays pour l'exécution du lot. Fournir en codes ISO 3166-1 alpha-2 comme US(USA), IN(Inde), etc.

​
parser
object

Tu peux utiliser ce paramètre pour spécifier l'analyseur à utiliser. Les analyseurs sont utiles pour extraire du contenu structuré des pages web. Olostep a quelques analyseurs intégrés pour les pages web les plus courantes, et tu peux aussi créer tes propres analyseurs.

​
links_on_page
object

Obtiens tous les liens présents sur chaque page du lot.

​
metadata
object

Ensemble de paires clé-valeur pour stocker des informations supplémentaires sur un objet. Suit l'approche de Stripe avec des règles de validation : max 50 clés, clé max 40 caractères (pas de crochets), valeur max 500 caractères, toutes les valeurs stockées en tant que chaînes.

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

URL HTTPS pour recevoir une requête POST lorsque le lot est terminé. Doit être une URL publiquement accessible utilisant le protocole http:// ou https://. Ne peut pas pointer vers localhost ou des adresses IP privées. Voir Webhooks pour le format de la charge utile et le comportement de réessai.

Réponse

Lot démarré avec succès.

​
id
string

ID du lot

​
object
string

Le type d'objet. "batch" pour ce point de terminaison.

​
status
string

in_progress ou completed

​
created
number

Époque créée

​
total_urls
number

Nombre d'URLs dans le lot

​
completed_urls
number

Nombre d'URLs complétées

​
parser
string
​
country
string
​
metadata
object

Ensemble de paires clé-valeur pour stocker des informations supplémentaires sur un objet. Suit l'approche de Stripe avec des règles de validation : max 50 clés, clé max 40 caractères (pas de crochets), valeur max 500 caractères, toutes les valeurs stockées en tant que chaînes.

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

URL du webhook pour recevoir la notification de fin