Saltar al contenido principal
Nuestra plataforma proporciona una forma flexible de enriquecer entidades con información definida por el usuario a través de Metadata. Esta característica está disponible en todas las entidades dentro de nuestra API, permitiéndole adjuntar datos personalizados como pares clave-valor dentro de un objeto metadata. Metadata es una herramienta poderosa para agregar información relevante y definida por el usuario a las entidades de la API, permitiéndoles contener datos específicos para sus necesidades de integración. Metadata puede agregarse en cualquier momento, haciendo que las entidades sean más adaptables a requisitos en evolución. Recomendamos usar metadata para mejorar sus integraciones de API, creando una experiencia que se alinee con las necesidades de su aplicación.

​
¿Qué es metadata?

Metadata le permite almacenar información complementaria junto con el modelo de datos estándar de una entidad, agregando atributos personalizados o anotaciones sin alterar el esquema predefinido de la entidad. Esta flexibilidad proporciona a las entidades un contexto adicional, haciéndolas adaptables a requisitos específicos. En Midaz, metadata es un objeto que admite pares clave-valor en estos tipos de datos: cadenas de texto (hasta 100 caracteres), enteros, flotantes y booleanos.
Metadata no admite valores anidados.

​
Ejemplo de metadata

Considere una entidad Organización como se muestra a continuación: 
{
  "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
  "parentOrganizationId": null,
  "legalName": "Empresa Teste Ltda",
  "doingBusinessAs": "Empresa Teste",
  "legalDocument": "86820799000188",
  "address": {
    "line1": "Rua Botucatu, 10",
    "line2": "Casa B",
    "zipCode": "04023060",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "metadata": null,
  "status": {
    "code": "ACTIVE",
    "description": null
  },
  "createdAt": "2024-02-08T16:59:31+0300",
  "updatedAt": "2024-02-08T16:59:31+0300",
  "deletedAt": null
}
Para enriquecer esta organización con información adicional, como el sector industrial y el número de empleados, puede incluir un objeto metadata en sus solicitudes POST, PUT o PATCH: 
{
  "metadata": {
    "sector": "Fintech",
    "employees": "50-100"
  }
}

​
Crear entidades con metadata

Al crear una entidad, puede enviar metadata a través de nuestros endpoints POST, permitiéndole agregar datos personalizados desde el inicio. Esta característica ayuda a crear una representación detallada y completa de cada entidad en su sistema.

​
Actualizar y eliminar metadata

Nuestra API sigue el RFC JSON Merge Patch para actualizaciones de metadata, asegurando que los metadata permanezcan adaptables y actualizados:
  • Agregar o Actualizar Valores: Enviar una clave con un nuevo valor en una solicitud PUT o PATCH actualiza los metadata existentes.
  • Eliminar Claves: Omitir una clave previamente incluida en una solicitud PUT o PATCH posterior elimina ese par clave-valor de los metadata de la entidad.

​
Ejemplo práctico: modificar metadata

Suponga que una entidad Organización inicialmente incluyó metadata para el sector y el conteo de empleados. Para actualizar el conteo de empleados mientras elimina el sector, envíe una solicitud PATCH con los siguientes metadata: 
{
  "metadata": {
    "employees": "100-150"
  }
}
Después de procesar la solicitud, la clave sector será eliminada y el conteo de empleados será actualizado.