Base de conhecimento

Uso Interno

GUIA DE APIs MULTIDADOSTI

Updated on 18 de junho de 2026
Funcionalidades
11 Views

Guia Unificado de APIs Multidados

Este guia explica como diferentes sistemas podem se conectar e trocar informações com o Multidados. O sistema evoluiu ao longo do tempo, oferecendo hoje três caminhos (APIs) principais, cada um com suas características e finalidades.

Visão Geral: As Três Gerações

CARACTERÍSTICA API 1.0 SOAP API 2.0 REST API 3.0 MULTIDADOS
Estilo SOAP (Protocolo Rígido) REST (Estilo Flexível) REST Moderno (Foco em Agilidade)
Linguagem Principal XML (Mais pesado/robusto) JSON ou XML JSON (Leve e rápido)
JSON (Leve e rápido) /webservices/api.php /webservices/rest/api.php /api/json/ ou /api
Documentação Manual Técnico (PDF) Manual Técnico (PDF) Swagger (Manual Interativo)
Autenticação Usuário e Senha Padrão Token ou Usuário/Senha Token de Autorização Moderno

Entendendo os Termos Técnicos

Para facilitar a leitura, aqui está uma tradução simples do que significam esses nomes:

  • API: É uma “ponte” que permite que dois sistemas diferentes conversem entre si de forma automática.
  • SOAP: Um conjunto de regras muito rígidas e formais para essa conversa. É como um contrato oficial em papel.
  • REST: Um estilo de conversa mais moderno e informal, muito usado em sites e aplicativos atuais.
  • XML e JSON: São as “línguas” que os sistemas usam. O XML é mais detalhado e formal, enquanto o JSON é mais simples e rápido de ler.
  • Swagger: Um manual de instruções onde você pode clicar e testar os comandos na hora, sem precisar programar nada primeiro.
  • Webhook: é uma forma de comunicação automática entre sistemas.

Segurança e Configurações Globais

Qualquer que seja a versão escolhida, existem controles que protegem seus dados:

Lista de IPs Autorizados (Whitelisting)

  • Você pode decidir quais computadores/servidores têm permissão para “chamar” o Multidados.
  • Onde configurar: [vmulti]?m=webservices&a=config_webservice
  • Como funciona: Se o campo estiver vazio, qualquer servidor (desde que tenha a senha) acessa. Se você colocar os números de IP, o sistema só responderá a esses endereços específicos.

Gatilhos de Automação (Webhooks)

Na mesma tela, você decide o que acontece após uma integração:

  • Rodar integrações externas: Se marcado, quando um dado entra via API, o sistema dispara automaticamente as tarefas automáticas configuradas (como enviar um e-mail ao abrir uma ocorrência). Se desmarcado, o dado entra “silenciosamente”.

Detalhamento das Versões

API 1.0 – SOAP (Webservices)

Ideal para sistemas de gestão (ERPs) tradicionais que rodam em diferentes sistemas operacionais (Linux/Windows).

  • Foco: Lógica de negócio e processos de fundo.
  • Uso Comum: Integração com o Mega CRM e sincronização de grandes volumes.
  • Métodos Famosos: Começam com “Dados” (Ex: DadosClientes, DadosTimesheet).

API 2.0 – REST

Uma transição que trouxe mais flexibilidade e suporte ao JavaScript, facilitando a criação de portais para clientes.

  • Vantagem: É mais rápida e usa menos “largura de banda” (internet) que o SOAP, pois permite o uso de formatos mais leves como o JSON.
  • Uso Comum: Portais web customizados e projetos específicos.

API 3.0 – MULTIDADOS (Swagger)

A versão mais moderna, recomendada para novos parceiros, aplicativos móveis e ferramentas de automação (como Zapier ou Make).

  • O Diferencial: O manual se “documenta sozinho”. Através do Swagger UI, o desenvolvedor vê todos os comandos, o que deve enviar e o que vai receber, podendo testar tudo direto no navegador.
  • Benefício: Reduz drasticamente o tempo e o custo de desenvolvimento.

Limites e Desempenho (Paginação)

Para garantir que o sistema não fique lento para os usuários, existe um limite de segurança:

  • Limite de 3000 resultados: Cada consulta retorna no máximo 3000 linhas de dados.
  • Por que existe? Para manter respostas rápidas, economizar memória dos servidores e evitar sobrecargas.
  • Como buscar mais dados? Use a Paginação. Se você precisa de 15.000 registros, fará 5 pedidos de 3000 cada, avisando ao sistema qual “página” quer em cada vez.

Dica para Grandes Volumes

Se o volume for gigante, a recomendação é espelhar os dados:

  • Baixe os dados massivos fora do horário comercial.
  • Use filtros de “data de modificação” para buscar apenas o que mudou desde a última atualização. Isso torna o processo muito mais leve e eficiente.

Qual API escolher?

  • Sistemas muito antigos ou legados: Use a API 1.0.
  • Aplicativos modernos, Dashboards ou Mobile: Use a API 3.0.
  • Funções específicas de scripts antigos: Verifique a API 2.0.

Links de Acesso (Exemplos)