MultiClubes AutoSeg 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 compõem a API. Este manual se destina aos integradores na implementação do projeto de gestão de grupos e usuários com as soluções MultiClubes e MultiVendas.

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

  • Conta: usuário que utiliza o sistema.
  • Acesso: grupo de usuários utilizado para gerenciar permissões do sistema.
  • Componente crítico: permissão para utilizar determinadas funcionalidades do sistema.

Relacionamento

  • Conta não possui componente crítico diretamente.
  • Conta pertence a nenhum, um ou mais acessos.
  • Acesso é a entidade que recebe os componentes críticos.
  • Acesso possui nenhum, um ou mais contas.
  • Componente crítico só pode ser atribuído a acessos.
  • Componente crítico está atribuído a nenhum, um ou mais acessos.

Funcionamento

  • Cadastra, edita, lista e remove contas nas aplicações.
  • Bloqueia e desbloqueia contas das aplicações.
  • Redefine senha de uma conta através do método de edição.
  • Atribui e revoga contas a acessos.
  • Lista contas, acessos e componentes críticos das aplicações.
  • Lista componentes críticos associados a acessos.
  • Lista acessos a que uma conta está associada.

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

28/11/2019

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

1.0.1

30/04/2020

  1. Foi renomeado a classe ListAllAccessesResult para AccessResult.
  2. Foi renomeado a classe ListAllAccountsResult para AccountResult.
  3. O método UpdateAccount foi alterado para retornar um boolean.
  4. O método AddAccess foi alterado para retornar um boolean.
  5. O método RemoveAccess foi alterado para retornar um boolean.
  6. O método BlockAccount foi alterado para retornar um boolean.
  7. O método UnblockAccount foi alterado para retornar um boolean.
  8. Foi acrescentado ao retorno do método ListAllAccounts as propriedades Status, CreationDate, CreationUser, LastUpdateDate e LastUpdateUser.
  9. Foi criado o método ListAccount que retorna dados de uma conta individual.
  10. Foi criado o método ListAccess que retorna dados de um perfil de acesso individual.
  11. O método BlockAccount foi modificado para permitir desativar uma conta do MultiVendas.
  12. O método UnblockAccount foi modificado para permitir desativar uma conta do MultiVendas.
  13. Foi removido o código de erro InvalidOperation.