Pular para o conteúdo principal

Introdução

Esta documentação — parte do portal de documentações técnicas da ABRAMUS — é a referência oficial dos formatos DDEX (Digital Data Exchange) usados pela ABRAMUS para o intercâmbio de dados de obras musicais, fonogramas e direitos com parceiros e provedores de serviço. Ela tem dois objetivos:

  1. Explicar de forma navegável a estrutura de cada mensagem DDEX (elementos, campos obrigatórios, valores permitidos), com exemplos reais.
  2. Permitir que integradores validem um arquivo XML sem precisar enviá-lo para o serviço da ABRAMUS — a validação roda inteiramente no navegador.

Formatos cobertos​

  • MWN — Musical Work Notification (v1.3.1): notificação de obras musicais e suas participações (RightShares).
  • RDR-N — Recording Data and Rights Notification (v1.5): notificação de fonogramas e dos direitos sobre eles.

Por onde começar​

MWN

  • Visão geral — o que é a mensagem, os cenários de troca (choreography) suportados.
  • Elementos — descrição de cada bloco da mensagem e seus campos obrigatórios.
  • Domínios e valores permitidos — listas de valores controlados (tipos de direito, papéis de participante, idiomas etc.), com o mapeamento usado internamente pela ABRAMUS (ECAD).
  • Exemplos — arquivos XML reais para cada cenário.
  • Validador — envie um arquivo e veja o resultado da validação, sem que ele saia do seu navegador.

RDR-N

  • Visão geral — as mensagens do padrão e a estrutura do SoundRecording.
  • Elementos — campos obrigatórios por bloco.
  • Domínios e valores permitidos — campos controlados mais relevantes.
  • Exemplos — um exemplo v1.5 validado, mais material de referência de versões anteriores.
  • Validador — mesma validação client-side, para arquivos RDR-N.
Importante

A validação deste site verifica apenas a estrutura do XML contra o schema oficial (XSD). Ela não substitui as regras de negócio aplicadas no upload real para a ABRAMUS (ex: soma de percentuais de RightShare, papéis de compositor válidos, similaridade do nome do remetente). Um arquivo pode passar aqui e ainda ser rejeitado no upload — e, em tese, o contrário também. Veja mais detalhes nas páginas de cada Validador.

Como obter credenciais​

Este site não exige login — a documentação e o validador funcionam sem credenciais. Mas para de fato enviar um arquivo MWN ou RDR para a ABRAMUS (fora deste site, via POST /ddex/upload/{tipo} — veja a API de Envio com os links do Swagger de cada ambiente), é necessário um clientId/secret. Esse processo não é autoatendido:

  1. Entre em contato com o A&R da unidade ABRAMUS mais próxima — veja a lista de unidades em abramus.org.br/unidadespg.
  2. O A&R fornecerá as credenciais do ambiente de testes/homologação, para validar sua integração sem afetar dados reais.
  3. Após a aprovação da integração testada em homologação, as credenciais de produção serão enviadas.