Introduction
Les métadonnées vous permettent de stocker vos propres données clé-valeur sur les objets Dodo Payments, comme un ID de commande provenant de votre système ou une référence CRM. Vous pouvez associer des métadonnées à la plupart des objets, notamment aux paiements, abonnements, clients et produits. Consultez la section Objets pris en charge pour obtenir la liste complète.Aperçu
Les métadonnées suivent les règles suivantes :- Les clés de métadonnées peuvent comporter jusqu’à 40 caractères (jusqu’à 100 caractères pour les événements d’utilisation ingérés via
POST /events/ingest). - Les valeurs de métadonnées peuvent être une chaîne, un entier, un nombre ou une valeur booléenne. Les valeurs de type chaîne peuvent comporter jusqu’à 500 caractères.
- Les objets, les tableaux et
nullne sont pas acceptés comme valeurs de métadonnées. - Vous pouvez ajouter jusqu’à 50 paires clé-valeur de métadonnées par objet. Une requête qui en contient davantage renvoie le
MAXIMUM_KEYS_REACHEDcode d’erreur. - L’API ne peut pas effectuer de recherche ni de filtrage par métadonnées, mais elle renvoie les métadonnées dans les réponses de l’API et les webhooks.
Cas d’utilisation
Utilisez les métadonnées pour :- Stocker des ID ou des références externes.
- Ajouter des notes internes.
- Relier les objets Dodo Payments aux enregistrements de votre système.
- Catégoriser les transactions.
- Ajouter des attributs personnalisés pour les rapports.
Ajouter des métadonnées
Ajoutez des métadonnées lorsque vous créez ou mettez à jour un objet via l’API. Pour les produits, vous pouvez également ajouter des métadonnées dans le tableau de bord.Via l’API
Transmettez un objetmetadata dans le corps de la requête. Les exemples ci-dessous utilisent le SDK TypeScript et supposent qu’un client a été initialisé :
Via l’interface du tableau de bord (produits uniquement)
Pour ajouter des métadonnées à un produit sans écrire de code, ouvrez le produit dans Produits et ajoutez des paires clé-valeur dans la section des métadonnées. Vous pouvez le faire lors de la création ou de la modification du produit.
Récupérer les métadonnées
Les réponses API incluent les métadonnées lorsque vous récupérez un objet :La récupération d’une session de paiement (
GET /checkouts/{id}) ne renvoie pas metadata. La réponse relative à l’état de la session contient uniquement id, created_at, payment_id, payment_status, customer_email et customer_name. Pour lire les métadonnées que vous avez associées lors de la création de la session, récupérez le paiement correspondant avec l’payment_id renvoyé.Rechercher et filtrer
L’API ne peut pas effectuer de recherche par métadonnées. Pour trouver un objet à partir d’une valeur de métadonnée :- Stockez vos identifiants importants dans les métadonnées.
- Répertoriez les objets ou récupérez-les via l’API.
- Filtrez les résultats dans le code de votre application.
Bonnes pratiques
Suivez ces recommandations pour conserver des métadonnées utiles.À faire :
- Utilisez des conventions de nommage cohérentes pour les clés de métadonnées.
- Documentez votre schéma de métadonnées en interne.
- Gardez des valeurs courtes et pertinentes.
- Utilisez les métadonnées uniquement pour les données statiques.
- Envisagez des préfixes indiquant le système source, par exemple
crm_idouinventory_sku.
À éviter :
- Stocker des données sensibles dans les métadonnées.
- Utiliser les métadonnées pour des valeurs qui changent fréquemment.
- Dépendre des métadonnées pour une logique métier critique.
- Dupliquer les informations déjà contenues dans l’objet.
- Utiliser des caractères spéciaux dans les clés de métadonnées.