API REST

A API do FluenzR permite integrar a plataforma às suas ferramentas e automatizar seus fluxos de trabalho.

Info A API REST está disponível apenas no plano Pro.

Visão Geral

A API do FluenzR é uma API REST que permite:

• Gerenciar seus contatos programaticamente
• Criar e controlar campanhas
• Recuperar estatísticas
• Receber webhooks sobre eventos

URL Base

https://api.fluenzr.co/v1

Formato das respostas

Todas as respostas estão no formato JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 150
  }
}

Em caso de erro

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": { ... }
  }
}

Códigos HTTP

Limitação de taxa

Os cabeçalhos de resposta indicam seu uso:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 950
X-RateLimit-Reset: 1640000000

Paginação

Endpoints que listam recursos suportam paginação:

GET /contacts?page=2&perPage=50

Filtragem

Filtre resultados com parâmetros de consulta:

GET /contacts?email=example.com&group=123

Ordenação

Ordene os resultados:

GET /contacts?sort=createdAt&order=desc

Endpoints disponíveis

Contatos

Grupos

Campanhas

Webhooks

SDKs e bibliotecas

JavaScript/TypeScript

npm install @fluenzr/sdk

import { FluenzrClient } from '@fluenzr/sdk';

const client = new FluenzrClient({
  apiKey: 'your-api-key'
});

const contacts = await client.contacts.list();

Python

pip install fluenzr

from fluenzr import FluenzrClient

client = FluenzrClient(api_key='your-api-key')
contacts = client.contacts.list()

Exemplos de uso

Sincronizar um CRM

// Obter novos contatos do seu CRM
const crmContacts = await myCRM.getNewContacts();

// Criá-los no FluenzR
for (const contact of crmContacts) {
  await fluenzr.contacts.create({
    email: contact.email,
    firstName: contact.first_name,
    lastName: contact.last_name,
    company: contact.company
  });
}

Automatizar uma campanha

// Criar uma campanha via API
const campaign = await fluenzr.campaigns.create({
  name: 'Automated Q1 2025',
  emailAccountId: 'acc_123',
  // ...
});

// Adicionar contatos
await fluenzr.campaigns.addContacts(campaign.id, {
  groupId: 'grp_456'
});

// Iniciar
await fluenzr.campaigns.start(campaign.id);

Exportar estatísticas

// Obter estatísticas de todas as campanhas
const campaigns = await fluenzr.campaigns.list();

for (const campaign of campaigns) {
  const stats = await fluenzr.campaigns.getStats(campaign.id);
  console.log(`${campaign.name}: ${stats.openRate}% aberturas, ${stats.replyRate}% respostas`);
}

Suporte

Para qualquer dúvida sobre a API:

• Documentação detalhada: api.fluenzr.co/docs
• Suporte: api-support@fluenzr.co
• Status: status.fluenzr.co