E-mail marketing
Kit no seu produto e nos seus agentes de IA, por uma API
O toolkit do Kit cobre inscritos, tags, formulários, segmentos, broadcasts com suas estatísticas e estatísticas de crescimento: listar, criar, atualizar e aplicar. O cliente conecta o Kit uma vez por OAuth no seu próprio app, e o Connect renova os tokens e registra cada execução, para o seu produto ou agente de IA fazer e-mail marketing sem uma integração própria.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/kit_create_subscriber/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email_address": "<email_address>"
}
}Como funciona
Do cliente conectado à primeira chamada no Kit.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do Kit. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o Kit.
Adicionar cadastros à lista
Quando alguém se cadastra no seu produto, crie o inscrito e aplique uma tag, o que também dispara as automações da conta que começam com essa tag.
Rascunhar e agendar broadcasts
Crie um broadcast como rascunho, segmente por segmentos e tags com subscriber_filter e agende com send_at quando o usuário aprovar.
Relatórios de crescimento da audiência
Leve List broadcast stats e Get growth stats para um painel dos clientes da sua agência: aberturas, cliques, novos inscritos e cancelamentos.
Tools
13 tools do Kit
- Listar inscritosGETLista os inscritos com id, e-mail, nome, estado e campos personalizados, apenas os ativos por padrão. Busque um por email_address. A resposta traz subscribers e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar inscritoPOSTCria um inscrito ativo. Quando o e-mail já pertence a um inscrito, atualiza o nome desse inscrito em vez disso. Não adiciona tag: use Apply tag em seguida.
- Atualizar inscritoPUTAtualiza o e-mail, o nome ou os campos personalizados de um inscrito. Uma chave de campo personalizado que não existe na conta faz a requisição falhar.
- Listar tagsGETLista as tags com id, nome e data de criação. A resposta traz tags e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar tagPOSTCria uma tag e a retorna com seu id. Quando já existe uma tag com o mesmo nome, sem diferenciar maiúsculas, retorna essa tag em vez de uma duplicada.
- Aplicar tagPOSTAplica uma tag a um inscrito existente, encontrado pelo e-mail. As automações da conta que começam com essa tag rodam para o inscrito. Crie o inscrito antes com Create subscriber.
- Listar formuláriosGETLista os formulários e landing pages com id, nome, tipo e URL de incorporação, apenas os ativos por padrão. A resposta traz forms e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar segmentosGETLista os segmentos com id e nome. Os segmentos são criados no app do Kit, e seus ids definem o público de um broadcast em subscriber_filter. A resposta traz segments e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Listar broadcastsGETLista os broadcasts com id, assunto, conteúdo, status, send_at, segmentação e template de e-mail. A resposta traz broadcasts e pagination; enquanto has_next_page for true, envie pagination.end_cursor como after.
- Criar broadcastPOSTCria um e-mail broadcast como rascunho, ou o agenda quando send_at está definido. Vai para todos os inscritos, ou apenas para os segmentos e tags de subscriber_filter. Retorna o broadcast com seu id.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/kit, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
Perguntas sobre o toolkit do Kit
Preciso implementar a API do Kit?
Não. O Connect já traz 13 tools do Kit descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do Kit?
Pelo modo que o toolkit aceita: OAuth com o app do seu produto. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
