Passer au contenu principal
Actuellement disponible pour Lots. La prise en charge des scrapes, crawls, cartes et réponses arrive bientôt.
Les métadonnées vous permettent d’attacher des paires clé-valeur personnalisées aux ressources Olostep. Cela est utile pour le suivi, le filtrage, l’organisation et le stockage du contexte avec vos requêtes API. Les métadonnées suivent l’approche de Stripe — simple, flexible et cohérente sur tous les points d’accès.

​
Cas d’utilisation

Suivi & Organisation

Liez des ressources à des systèmes internes avec des ID de commande, des ID de client ou des noms de projet.

Filtrage & Recherche

Étiquetez des ressources pour un accès et un filtrage faciles dans votre application.

Contexte de Workflow

Stockez le stade du pipeline, le niveau de priorité ou les instructions de traitement.

Piste d'audit

Enregistrez qui a initié une requête, les horodatages ou les informations de version.

​
Ajout de métadonnées lors de la création

Incluez le paramètre metadata lors de la création d’une ressource : 
{
  "url": "https://example.com",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "internal_ref": "proj-2024-001"
  }
}
Les métadonnées sont renvoyées dans toutes les réponses GET suivantes pour cette ressource.

​
Règles de validation

ContrainteLimiteExemple d’erreur
Clés maximum50"Les métadonnées peuvent avoir un maximum de 50 clés. Vous avez fourni 51 clés."
Longueur de la clé40 caractères"La clé de métadonnée \"my_very_long_key_name...\" dépasse la limite de 40 caractères."
Format de la cléPas de crochets"La clé de métadonnée \"items[0]\" ne peut pas contenir de crochets ([ ou ])."
Longueur de la valeur500 caractères"La valeur de métadonnée pour la clé \"description\" dépasse la limite de 500 caractères."
Type de valeurUniquement des chaînes"La valeur de métadonnée pour la clé \"count\" doit être une chaîne. Objet reçu."
Conversion de type : Les nombres et booléens sont automatiquement convertis en chaînes.
  • 42 → "42"
  • true → "true"
  • 3.14 → "3.14"
Les objets et tableaux sont rejetés.

​
Mise à jour des métadonnées (PATCH)

Actuellement disponible pour : Lots uniquement.Les crawls, scrapes, cartes et réponses ne prennent pas encore en charge la mise à jour des métadonnées après création.
Vous pouvez mettre à jour les métadonnées sur les lots existants en utilisant le point d’accès PATCH. Les mises à jour utilisent un comportement de fusion.

​
Opérations de mise à jour

De nouvelles clés sont ajoutées tout en préservant les existantes.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"new_key": "new_value"}}'
Avant : {"project": "alpha"}
Après : {"project": "alpha", "new_key": "new_value"}
Les clés existantes sont remplacées par de nouvelles valeurs.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "beta"}}'
Avant : {"project": "alpha", "priority": "high"}
Après : {"project": "beta", "priority": "high"}
Définissez une clé sur null ou "" (chaîne vide) pour la supprimer.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"priority": null}}'
Avant : {"project": "alpha", "priority": "high"}
Après : {"project": "alpha"}
Définissez le champ de métadonnées entier sur null ou "" pour supprimer toutes les clés.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": null}'
Avant : {"project": "alpha", "priority": "high"}
Après : {}
Ajoutez, mettez à jour et supprimez des clés dans une seule requête.
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "gamma", "new_field": "value", "old_field": null}}'
Avant : {"project": "alpha", "old_field": "remove_me"}
Après : {"project": "gamma", "new_field": "value"}

​
Résumé du comportement PATCH

OpérationRequêteRésultat
Ajouter une clé{"metadata": {"new": "value"}}Clé ajoutée, autres préservées
Mettre à jour une clé{"metadata": {"existing": "new_value"}}Clé mise à jour, autres préservées
Supprimer une clé{"metadata": {"key": null}}Clé supprimée, autres préservées
Supprimer une clé{"metadata": {"key": ""}}Clé supprimée, autres préservées
Effacer tout{"metadata": null}Toutes les clés supprimées
Effacer tout{"metadata": ""}Toutes les clés supprimées
Aucune action{"metadata": {}}Aucun changement