app2email API Preços

Documentação

Arquivos de configuração

Um arquivo de configuração guarda toda a configuração de uma integração em um único arquivo de texto. Baixe-o como backup, altere muitas coisas de uma vez, copie uma configuração para outro número ou deixe um agente de IA configurar tudo pela API ou pelo MCP. Todo envio é verificado antes e pode ser desfeito.

Um arquivo de configuração guarda tudo o que você configura em uma integração: as configurações, os serviços e a equipe do Book-and-Pay, as categorias, opções e produtos do Order-and-Pay, os eventos, datas e tipos de ingresso do Tickets-and-Pay e os formulários e automações do Submit-Info. É um único arquivo de texto, então você pode guardá-lo como backup, alterá-lo em qualquer editor, enviá-lo de novo ou copiá-lo para outro dos seus números.

O mesmo arquivo funciona em três lugares: o painel, a API e o servidor MCP para agentes de IA.

No painel

Cada integração tem uma seção Arquivo de configuração:

IntegraçãoOnde
Book-and-Paya aba Visão geral, na parte de baixo
Order-and-Paya aba Importar e exportar, na parte de baixo
Tickets-and-Paya aba Configurações, na parte de baixo
Submit-Infoa aba Configurações, na parte de baixo

Só o proprietário e os administradores de um número a veem.

  1. 1. Baixar

    Baixar entrega a configuração como um arquivo .a2e.jsonl. Baixar com imagens entrega um .zip com o mesmo arquivo e todas as imagens dentro: um backup offline completo que você pode enviar de novo como está.

  2. 2. Alterar

    Abra o arquivo em um editor de texto e altere, adicione ou remova linhas. Cada linha é uma coisa: um serviço, um produto, um evento. Não é preciso uma planilha.

  3. 3. Enviar

    Enviar um arquivo o verifica primeiro. Nada muda ainda. Você vê cada problema com o número da linha e como corrigi-lo, ou o que a aplicação faria: quantas coisas são novas, alteradas ou removidas, e quais.

  4. 4. Aplicar

    Aplicar faz exatamente as alterações que a verificação mostrou. Uma verificação continua válida por 1 hora.

  5. 5. Desfazer

    Toda aplicação é listada em Alterações recentes por arquivo de configuração. Desfazer restaura tudo o que essa aplicação alterou, por 30 dias, desde que nenhuma aplicação posterior tenha alterado a mesma integração. Desfaça primeiro a mais recente.

Adicionar e alterar, ou deixar exatamente como o arquivo

Antes de enviar, escolha o que acontece com as coisas que o arquivo não lista:

  • Adicionar e alterar (o padrão): as linhas do arquivo são criadas ou alteradas, e todo o resto fica como está. Um arquivo com apenas cinco linhas altera apenas essas cinco coisas.
  • Deixar exatamente como o arquivo: tudo do mesmo tipo que o arquivo não lista é removido. Um produto é arquivado, nunca excluído. A verificação lista cada remoção antes de você aplicar.

Copiar para outro número

Se você é proprietário ou administrador de mais de um número, Copiar para outro número copia a configuração de uma integração do número em que você está para outro: uma segunda filial, um número de teste ou um modelo que você entrega a cada nova loja.

A cópia é verificada primeiro no outro número e mostra o que ela alteraria lá. Copiar agora a aplica. As imagens vão junto. Para desfazer uma cópia, abra a mesma integração no outro número: a cópia está listada ali em Alterações recentes.

Note

O endereço web do Book-and-Pay, do Order-and-Pay e do Tickets-and-Pay pertence a um único número e nunca é copiado. Defina o endereço do outro número no painel dele.

O que um arquivo de configuração guarda

IntegraçãoLinhas
Book-and-Paybooking.settings (uma linha por seção: horários, web, marca, mensagens ...), booking.service, booking.provider (equipe)
Order-and-Payshop.settings (uma linha por seção, incluindo a aparência da página de pedidos), shop.category, shop.option_group, shop.item (com variações e imagens)
Tickets-and-Paytickets.settings (uma linha por seção; wa_templates é o seu próprio texto das mensagens de WhatsApp), tickets.chart (mapas de assentos salvos), tickets.event (com as datas, os tipos de ingresso, os limites compartilhados, as imagens e o mapa de assentos), tickets.promo
Submit-Infosubmit.settings, submit.list, submit.connection, submit.form, submit.automation
Todasasset: uma imagem, identificada pelas linhas que a usam

Nunca em um arquivo

  • Segredos: chaves de pagamento, senhas de conexão e tokens. Um segredo guardado continua como está.
  • Ativar uma integração. Um arquivo nunca faz isso, e um arquivo nunca publica, cancela nem exclui um evento com ingressos.
  • O que os clientes fizeram: agendamentos, pedidos, ingressos vendidos, envios, clientes, pagamentos.
  • Membros da equipe e logins da equipe.
  • Os números de estoque do Order-and-Pay, a menos que você marque Definir também os números de estoque a partir do arquivo. Sem isso, um arquivo que você exportou de manhã não pode desfazer as vendas do dia.

O formato

Um arquivo de configuração é um JSON Lines: um objeto JSON por linha. A primeira linha diz o que o arquivo é; cada uma das outras linhas é um registro com um type e uma key. A chave encontra o mesmo registro na próxima vez: o id de um serviço, o SKU de um produto, o endereço de um evento.

{"type":"a2e.setup","version":1,"products":["booking"]}
{"type":"booking.service","key":"haircut","name":"Haircut","duration_min":30,"price":"$25","price_amount":25}
{"type":"booking.service","key":"beard","name":"Beard trim","duration_min":15,"price":"$12","price_amount":12}
{"type":"booking.provider","key":"sam","name":"Sam","services":["haircut","beard"]}

A ordem das linhas não importa. Os preços do Book-and-Pay são valores (25 é 25,00, price é o rótulo mostrado ao lado); os preços do Order-and-Pay e do Tickets-and-Pay estão na menor unidade da moeda (1250 é 12,50). Os campos exatos de cada linha estão no guia da API (GET /v1/{number}/setup/guide).

Imagens

Um registro indica uma imagem pela chave de uma linha asset. A imagem vem de uma destas fontes:

  • url: um endereço https://, buscado por nós.
  • data: a própria imagem, em base64.
  • file: um caminho dentro do .zip enviado.
  • sha256: uma imagem que este número já tem.

Uma exportação grava o endereço público de cada imagem. Uma imagem que não tem endereço público, como a imagem da planta que fica atrás de um mapa de assentos, recebe um link assinado que funciona por 7 dias, de modo que um arquivo copiado para outro número ainda a leve consigo.

{"type":"asset","key":"classic-photo","url":"https://example.com/classic.jpg"}
{"type":"shop.item","key":"BURGER-CLASSIC","name":"Classic burger","category":"burgers","price":1250,"images":["classic-photo"]}

As imagens são PNG, JPEG ou WEBP, de no máximo 5 MB cada. Onde uma integração precisa, uma imagem é reduzida ou convertida em JPEG: um logotipo do Book-and-Pay para caber em 300 KB, uma imagem do Tickets-and-Pay para caber em 1 MB.

Para agentes de IA e a API

Um agente configura uma integração inteira em uma única etapa verificada, em vez de dezenas de chamadas. O servidor MCP https://api.app2email.com/mcp/setup tem estas ferramentas: get_setup_guide, export_setup, check_setup, apply_setup, upload_setup_asset, list_setup_jobs, get_setup_job e undo_setup. As mesmas chamadas estão na API:

ChamadaO que faz
GET /v1/{number}/setup/guidetodos os tipos de registro, os campos e os limites deles, com exemplos. Os agentes o leem primeiro
GET /v1/{number}/setup/exporto arquivo atual: format=jsonl, zip ou json
POST /v1/{number}/setup/checkverifica um arquivo e não altera nada: problemas por linha, o plano, um check_id
POST /v1/{number}/setup/applyaplica uma verificação: {"check_id": 123}
POST /v1/{number}/setup/assetsguarda uma imagem por 7 dias e responde o sha256 dela
GET /v1/{number}/setup/jobsas últimas verificações, aplicações e desfazimentos
POST /v1/{number}/setup/jobs/{id}/undorestaura o que uma aplicação alterou

A chave precisa da permissão própria da integração: bookings:manage, orders:manage, tickets:manage ou submissions:manage. Uma chave sandbox pode exportar e verificar, mas não aplicar.

Tip

O ciclo habitual de um agente: ler o guia, exportar o arquivo atual, alterar algumas linhas, verificar, corrigir o que a verificação relatar e então perguntar ao usuário antes de aplicar o check_id.

Limites

O quêLimite
Um arquivo20 MB de texto, 50.000 linhas (no painel, um envio de no máximo 19 MB)
Uma requisição com imagens dentro60 MB pela API
Uma imagem5 MB
Imagens buscadas por endereço100 por envio; o Order-and-Pay busca as imagens dos produtos em segundo plano, em alguns minutos
Arquivos grandesmais de 1.000 registros são verificados e aplicados em segundo plano; o painel espera por eles sozinho
Uma verificaçãopode ser aplicada em até 1 hora, uma vez
Desfazer30 dias