iPORTO iPORTO Logo
v1.0

Guia de ajuda da iPORTO

Visão Geral

A iPORTO é uma plataforma de orquestração de mensagens multicanal. Você pode enviar informações por e-mail e SMS, definindo regras de prioridade, fallback e conteúdo por público e contexto.

Aplicação Web

Para equipes que desejam operar via painel em app.iporto.com.br: criação de campanhas, fluxos simples, upload de listas, acompanhamento visual, vídeos e tutoriais passo a passo.

API/Desenvolvedores

Para integrações de sistema a sistema: endpoints REST, autenticação, webhooks, contratos e exemplos de requests/responses.

Aviso: Integrações adicionais estão em desenvolvimento. No momento, a API e os serviços da iPORTO oferecem suporte oficial a E‑mail (SMTP) e SMS.

Começo Rápido

Portal Web

Para operar pelo painel em app.iporto.com.br.
Guias úteis: Índice SMTP • Dados de Autenticação • Criar um domínio

API / Desenvolvedores

Para integrar via HTTP (envio por API) ou SMTP programático.
  • Gere uma Chave de API (Painel → Integração → API)
  • Teste o envio por API com o exemplo em Exemplos de uso
  • Opcional: configure SMTP no seu app (PHPMailer, Nodemailer, smtplib)
Recursos: API vs SMTP • Erros comuns

Checklist inicial

  • ✓ Conta administrativa acessível ao painel
  • ✓ Domínio validado (SPF/DKIM/DMARC)
  • ✓ Conta de autenticação criada e senha copiada (case sensitive)
  • ✓ Porta 587 (STARTTLS) liberada na sua rede
  • ✓ (API) Chave de API gerada e guardada com segurança
  • ✓ Envio de teste realizado com sucesso

Princípios Operacionais

Esta seção explica as opções de mensagens disponíveis hoje e como utilizá‑las com qualidade e conformidade.

E-mail (SMTP)

  • O que é: canal transacional e de relacionamento, ideal para recibos, confirmações, newsletters e comunicações mais ricas.
  • Requisitos: domínio validado (SPF, DKIM) e política DMARC recomendada para entregabilidade e reputação.
  • Recursos: templates HTML, anexos, personalização por variáveis, rastreio de abertura/clique quando aplicável.
  • Limites/boas práticas: aquecimento de domínio/IP, segmentação, opt‑out claro, conteúdo relevante e consistente com a marca.
  • Entregabilidade: monitore rejeições (bounces), queixas (complaints) e reputação de domínio para manter alta entrega.

SMTP: Como criar um domínio

  1. Verifique seu domínio no provedor DNS e garanta acesso para criar registros.
  2. Crie/valide registros SPF (ex.: v=spf1 include:_spf.seuprovedor ~all).
  3. Gere e publique chaves DKIM conforme instruções do provedor.
  4. Configure política DMARC (ex.: v=DMARC1; p=none; rua=mailto:dmarc@seudominio).
  5. Aguarde a propagação DNS e valide no painel da iPORTO.
  6. Faça um envio de teste e monitore rejeições/queixas.

SMS

  • O que é: mensagens curtas e imediatas, ideais para alertas, confirmações, autenticação (OTP) e comunicações urgentes.
  • Requisitos: registro de remetente/origem conforme regras do país; atenção a janelas de envio (horário comercial quando exigido).
  • Recursos: alta taxa de leitura, delivery reports (quando suportados pelo provedor), personalização básica.
  • Limites/boas práticas: objetividade, identificação da marca, respeito a consentimento/opt‑out e limites de frequência.
  • Custos: tipicamente tarifação por mensagem enviada/entregue, variando por DDD/país e categoria.

Roteamento, Prioridade e Fallback

  • Defina prioridade dos canais por tipo de evento (ex.: OTP → SMS, fatura → e‑mail).
  • Configure fallback: se um canal falhar (ex.: e‑mail bounce), tente outro canal conforme regras do seu fluxo.
  • Registre eventos de envio/entrega para rastreabilidade e auditoria.

Segurança e Governança

  • Isolamento lógico: cada tenant possui escopos de API, políticas de acesso e criptografia de dados segregada.
  • Trilhas de eventos: toda ação relevante é registrada com carimbo de tempo, usuário e tenant, favorecendo auditoria e conformidade.
  • Escalabilidade horizontal: os serviços são orquestrados para suportar crescimento de tenants e usuários sem perda de desempenho.

Primeiros Passos

Criar Conta Administrativa

  1. Acesse o Painel Administrativo → Integração → API.
  2. Crie uma Nova API.
  3. Defina o domínio raiz e políticas padrão (moeda, timezone, idioma, branding base).

Nota: a conta administrativa é usada tanto para gerir o próprio negócio quando o iPORTO atua como cliente interno, quanto para criar tenants de clientes.

Gerar uma Chave de API

  1. Acesse o Painel Administrativo → Integração → API.
  2. Crie uma Nova Chave de API.
  3. Configure níveis de acesso, quando aplicável.

Nota: chaves de API com escopo completo concedem acesso total ao tenant associado. Trate-as como senhas.

Aplicação Web

  • Para começar pelo painel, acesse app.iporto.com.br e utilize os tutoriais com vídeos e imagens.
  • Na barra lateral, entre em "Aplicação Web" para ver visão geral e mensagens/canais.

API/Desenvolvedores

  • Integre usando os endpoints públicos. Veja "API/Desenvolvedores" na barra lateral.
  • Exemplo disponível: cadastro de Tenant em POST /api/public/tenant/register.

Próximos Passos

  • Aplicação Web: veja abaixo "Aplicação Web" e a seção "Mensagens e Canais".
  • API: vá para "API/Desenvolvedores" → "Tenant" para seu primeiro endpoint.
  • API: vá para "API/Desenvolvedores" e escolha o serviço: envio de E‑mail, SMS ou Validação de E‑mail.

E-mail Marketing

  • O que é: ferramenta do Portal para criação e envio de campanhas com segmentação, templates e relatórios.
  • Disponibilidade: Portal Web (app). Integração por API planejada.

Validador de E‑mail

  • O que é: serviço para checagem de sintaxe/existência e reputação de endereços, reduzindo bounces.
  • Disponibilidade: Portal Web (app). Integração por API planejada.