Introducción
Los metadatos te permiten almacenar información adicional y estructurada sobre tus objetos en Dodo Payments. Puedes adjuntar metadatos a la mayoría de los objetos de Dodo Payments, incluidos pagos, suscripciones y más.
Descripción General
- Las claves de metadatos pueden tener hasta 40 caracteres
- Los valores de metadatos pueden ser una cadena, número o booleano; las cadenas pueden tener hasta 500 caracteres
- No se aceptan objetos, arreglos e
null como valores de metadatos
- Puedes tener hasta 50 pares clave-valor de metadatos por objeto
- Las claves deben contener solo caracteres alfanuméricos, guiones y guiones bajos
- Los metadatos no son buscables usando nuestra API pero se devuelven en las respuestas de la API y webhooks
Casos de Uso
Los metadatos son útiles para:
- Almacenar identificadores o referencias externas
- Agregar anotaciones internas
- Vincular objetos de Dodo Payments a tu sistema
- Categorizar transacciones
- Agregar atributos personalizados para informes
Puedes agregar metadatos al crear o actualizar objetos a través de la API. Para productos, también tienes la opción de agregar metadatos directamente desde la interfaz del panel de control.
A través de la API
A través de la Interfaz del Panel de Control (Solo Productos)
Para productos, también puedes agregar metadatos directamente desde el panel de control de Dodo Payments al crear o editar un producto. La sección de metadatos te permite agregar fácilmente pares clave-valor personalizados sin escribir código.
Utilizar la interfaz del panel para los metadatos del producto resulta especialmente útil para los miembros del equipo no técnicos que necesitan gestionar la información y las categorías de los productos.
Los metadatos se incluyen en las respuestas de la API al recuperar objetos:
Búsqueda y Filtrado
Aunque los metadatos no son directamente buscables a través de nuestra API, puedes:
- Almacenar identificadores importantes en metadatos
- Recuperar objetos utilizando sus ID primarios
- Filtrar los resultados en el código de tu aplicación
Mejores Prácticas
Haz:
- Utiliza convenciones de nomenclatura coherentes para las claves de metadatos
- Documenta tu esquema de metadatos internamente
- Mantén los valores cortos y significativos
- Utiliza metadatos solo para datos estáticos
- Considera usar prefijos para diferentes sistemas (por ejemplo,
crm_id, inventory_sku)
No Hagas:
- Almacenar datos sensibles en metadatos
- Usar metadatos para valores que cambian con frecuencia
- Confiar en metadatos para lógica empresarial crítica
- Almacenar información duplicada que esté disponible en otro lugar en el objeto
- Usar caracteres especiales en las claves de metadatos
Objetos Soportados
Los metadatos son compatibles con los siguientes objetos:
Los metadatos se incluyen en los eventos de webhook, lo que facilita el manejo de notificaciones con tus datos personalizados: