MultiClubes AttachDun API

Esta é a documentação dos serviços de comunicação da solução MultiClubes. Este manual tem como objetivo ajudar no entendimento e na implementação de uso dos serviços que compoem a API.

Comunicação

A comunicação suportada é SOAP sobre HTTPS com o uso do protocolo TLS 1.0 e SSL 3.0. O certificado fornecido pelo servidor deve ser inspecionado a cada nova conexão, para confirmar que se trata de um certificado confiável. A URL do servidor contida no certificado deve corresponder ao endereço correto do MultiClubes (multiclubes.com.br). Os dados devem estar codificados no formato UTF8.

Autenticação

O acesso à API é restrito aos parceiros cadastrados, sendo necessário informar, em cada conexão, a chave de autenticação fornecida pela nossa equipe de suporte técnico ao parceiro. A duração da chave é indeterminada, somente perdendo a validade caso a conta de acesso seja desativada. A chave de autenticação deve ser informada pelo cabeçalho da chamada pelo header com nome _AuthenticationKey com namespace ns.

Glossário

  • Número externo: numero opcional passado durante a chamada de anexar.
  • ID da venda: é o identificador único da venda.

Funcionamento

  • Attach anexa o produto com o valor passado a cobrança padrão do título informado, retornando o ID da venda.
  • Cancel cancela a cobrança pelo ID da venda ou pelo número externo.

Como começar

  1. Obtenha o endereço do serviço de homologação.
  2. Abra o endereço do serviço no navegador e obtenha a documentação WSDL.
  3. Realize chamadas em homologação para testes de reconhecimento.
  4. Integre as chamadas com seu software em homologação.
  5. Obtenha o endereço do serviço de produção.
  6. Realize chamadas em produção para testes de finalização.

Notas de versão

1.0.0

20/09/2023

  1. Criada esta documentação para auxiliar no entendimento e implementação.

1.0.1

23/05/2024

  1. Adicionado o campo Description à AttachData para permitir o envido da descrição da venda do produto que será anexada a cobrança do título.