Introdução
Os metadados permitem armazenar seus próprios dados de chave-valor em objetos do Dodo Payments, como um ID de pedido do seu sistema ou uma referência de CRM. Você pode anexar metadados à maioria dos objetos, incluindo pagamentos, assinaturas, clientes e produtos. Consulte Objetos compatíveis para ver a lista completa.Visão Geral
Os metadados seguem estas regras:- As chaves de metadados podem ter até 40 caracteres (até 100 caracteres para eventos de uso ingeridos por meio de
POST /events/ingest). - Os valores de metadados podem ser uma string, um inteiro, um número ou um booleano. Os valores de string podem ter até 500 caracteres.
- Objetos, arrays e
nullnão são aceitos como valores de metadados. - Você pode adicionar até 50 pares de chave-valor de metadados por objeto. Uma solicitação com mais pares retorna o
MAXIMUM_KEYS_REACHEDcódigo de erro. - A API não pode pesquisar nem filtrar por metadados, mas retorna metadados nas respostas da API e nos webhooks.
Casos de uso
Use metadados para:- Armazenar IDs ou referências externas.
- Adicionar notas internas.
- Vincular objetos do Dodo Payments a registros no seu sistema.
- Categorizar transações.
- Adicionar atributos personalizados para relatórios.
Adicionando metadados
Adicione metadados ao criar ou atualizar um objeto por meio da API. Para produtos, você também pode adicionar metadados no dashboard.Via API
Passe um objetometadata no corpo da solicitação. Os exemplos abaixo usam o SDK do TypeScript e pressupõem um client inicializado:
Via interface do dashboard (somente produtos)
Para adicionar metadados a um produto sem escrever código, abra o produto em Produtos e adicione pares de chave-valor na seção de metadados. Você pode fazer isso ao criar ou editar o produto.
Recuperando metadados
As respostas da API incluem metadados quando você recupera um objeto:A recuperação de uma sessão de checkout (
GET /checkouts/{id}) não retorna metadata. A resposta do status da sessão contém apenas id, created_at, payment_id, payment_status, customer_email e customer_name. Para ler os metadados anexados ao criar a sessão, recupere o pagamento resultante usando o payment_id retornado.Pesquisando e filtrando
A API não pode pesquisar por metadados. Para encontrar um objeto por um valor de metadado:- Armazene seus identificadores importantes nos metadados.
- Liste ou recupere objetos por meio da API.
- Filtre os resultados no código da sua aplicação.
Práticas recomendadas
Siga estas orientações para manter os metadados úteis.Faça:
- Use convenções de nomenclatura consistentes para as chaves de metadados.
- Documente internamente seu schema de metadados.
- Mantenha os valores curtos e significativos.
- Use metadados apenas para dados estáticos.
- Considere prefixos que identifiquem o sistema de origem, por exemplo
crm_idouinventory_sku.
Não faça:
- Armazene dados confidenciais nos metadados.
- Use metadados para valores que mudam com frequência.
- Dependa de metadados para lógica de negócios crítica.
- Duplique informações que o objeto já contém.
- Use caracteres especiais nas chaves de metadados.