Vai al contenuto principale

Introduzione

I metadati ti consentono di memorizzare informazioni aggiuntive e strutturate sui tuoi oggetti in Dodo Payments. Puoi allegare metadati alla maggior parte degli oggetti di Dodo Payments, inclusi pagamenti, abbonamenti e altro.

Panoramica

  • Le chiavi dei metadati possono essere lunghe fino a 40 caratteri
  • I valori dei metadati possono essere una stringa, un numero o un booleano; le stringhe possono essere lunghe fino a 500 caratteri
  • Oggetti, array e null non sono accettati come valori dei metadati
  • È possibile avere fino a 50 coppie chiave-valore di metadati per oggetto
  • Le chiavi devono contenere solo caratteri alfanumerici, trattini e underscore
  • I metadati non sono ricercabili utilizzando la nostra API ma sono restituiti nelle risposte API e nei webhook

Casi d’uso

I metadati sono utili per:
  • Memorizzare ID o riferimenti esterni
  • Aggiungere annotazioni interne
  • Collegare oggetti di Dodo Payments al tuo sistema
  • Categorizzare le transazioni
  • Aggiungere attributi personalizzati per la reportistica

Aggiungere Metadati

Puoi aggiungere metadati durante la creazione o l’aggiornamento degli oggetti tramite l’API. Per i prodotti, hai anche l’opzione di aggiungere metadati direttamente dall’interfaccia del dashboard.

Tramite API

Tramite Interfaccia Dashboard (Solo Prodotti)

Per i prodotti, puoi anche aggiungere metadati direttamente dal dashboard di Dodo Payments durante la creazione o la modifica di un prodotto. La sezione metadati ti consente di aggiungere facilmente coppie chiave-valore personalizzate senza scrivere codice.
Interfaccia dei metadati del prodotto nella dashboard Dodo Payments
L’uso dell’interfaccia della dashboard per i metadati del prodotto è particolarmente utile per i membri del team non tecnici che devono gestire le informazioni sui prodotti e le categorie.

Recuperare Metadati

I metadati sono inclusi nelle risposte API quando si recuperano oggetti:

Ricerca e Filtraggio

Sebbene i metadati non siano direttamente ricercabili tramite la nostra API, puoi:
  1. Memorizzare identificatori importanti nei metadati
  2. Recuperare oggetti utilizzando i loro ID primari
  3. Filtrare i risultati nel codice della tua applicazione

Migliori Pratiche

Fai:

  • Usare convenzioni di denominazione coerenti per le chiavi dei metadati
  • Documentare internamente lo schema dei metadati
  • Mantenere i valori brevi e significativi
  • Usare i metadati solo per dati statici
  • Valuta l’uso di prefissi per sistemi diversi (ad es., crm_id, inventory_sku)

Non fare:

  • Memorizzare dati sensibili nei metadati
  • Utilizzare i metadati per valori che cambiano frequentemente
  • Fare affidamento sui metadati per logiche aziendali critiche
  • Memorizzare informazioni duplicate disponibili altrove nell’oggetto
  • Utilizzare caratteri speciali nelle chiavi dei metadati

Oggetti Supportati

I metadati sono supportati sui seguenti oggetti:

Webhook e Metadati

I metadati sono inclusi negli eventi webhook, rendendo facile gestire le notifiche con i tuoi dati personalizzati:
Ultima modifica il 9 luglio 2026