1. Autenticação e Segurança
-
Chave de API: Utilize o parâmetro 'APIKey' em todas as chamadas.
-
Protocolo: É obrigatório o uso de HTTPS (SSL) em produção.
-
Endpoint Base: Varia por cliente (Ex: https://mbiz.mailclick.me/api.php ou https://news.mailclick.me/api.php).
2. Conceitos Básicos
-
Contato: Registro em uma lista (e-mail é obrigatório).
-
Campo Personalizado: Informações adicionais específicas do negócio vinculadas a uma lista.
-
Lista: Repositório onde os contatos são armazenados.
-
Segmento: Filtro dinâmico baseado em regras dentro de uma lista.
-
Campanha: Ação de e-mail marketing direcionada.
3. Principais Endpoints
Subscriber (Contatos)
-
Subscriber.Get: Busca dados de um contato específico por e-mail e ListID.
-
Subscriber.Subscribe: Cadastra ou atualiza (Upsert) um e-mail em listas.
-
Subscriber.Unsubscribe: Descadastra um contato de uma lista.
-
Subscriber.Update: Atualiza informações de um contato existente.
-
Subscriber.Interactions: Consulta aberturas, cliques e bounces.
Campaigns (Campanhas)
-
Campaign.Create: Cria uma nova campanha.
-
Campaign.Get / Campaigns.Get: Retorna detalhes de uma ou várias campanhas.
-
Campaign.Update: Atualiza dados de uma campanha existente.
Lists & Segments
-
List.Create / List.Update: Gerenciamento de listas de contatos.
-
Segment.Create / Segment.Update: Gestão de regras de segmentação.
AutoResponder (Automação)
-
AutoResponder.Webhook: Dispara e-mail automático via gatilho de Webhook.
-
Autoresponder.Sequences: Consulta em quais fluxos automáticos um cliente está inserido.
Media (Arquivos)
- Media.Upload / Media.Delete: Gerenciamento de arquivos no servidor Flowbiz.
4. Formato de Resposta
O padrão de retorno é JSON. Para chamadas cross-domain, o parâmetro 'JSONPCallBack' pode ser utilizado.