simpliers CHAT

API do Simpliers CHAT

Liste, publique e despublique suas automações.

Última atualização: 10 de setembro de 2026

Escopo

Esta API lê e muda o estado das automações criadas no painel. Não existem endpoints para criar, editar ou apagar uma automação, nem para enviar mensagens.

  • A autenticação funciona com uma chave Bearer no cabeçalho Authorization. A chave é criada no painel e o valor completo aparece somente no momento em que ela é criada.
  • O nível de acesso de uma chave é definido na criação e não muda depois: você escolhe ou apenas visualizar, ou visualizar com publicar e despublicar.
  • As requisições são enviadas apenas de um servidor. Requisições que levam o cabeçalho Origin retornam 403, então um navegador ou um aplicativo móvel não podem usar esta API.
  • O limite é de 120 requisições por minuto por chave e 300 por minuto por IP. Uma requisição acima do limite retorna 429.
Criar uma chave

Autenticação

Cada requisição leva uma única chave. Nenhum id de conta é enviado na requisição. A chave é criada no painel, na parte de chaves de API da aba Integrações nas configurações da conta.

  • Abra as configurações da conta no painel e vá para a parte de chaves de API da aba Integrações.
  • Crie uma chave nova e escolha o nível de acesso.
  • Guarde a chave nas variáveis de ambiente do seu servidor.

A chave é enviada no cabeçalho Authorization em cada requisição:

Authorization: Bearer smpl_...

A chave não pode ficar embutida em um navegador nem em um aplicativo móvel. Uma requisição que leva o cabeçalho Origin retorna 403 browser_origin_not_allowed, porque o navegador adiciona esse cabeçalho a cada requisição.

Níveis de acesso

O nível de acesso é escolhido ao criar a chave e não pode mudar por toda a vida da chave.

Apenas visualizar

Lê a lista de automações. Requisições que mudam o estado retornam 403 missing_scope.

Visualizar e gerenciar

Lê a lista de automações; publica ou despublica uma automação.

Endpoints

Todos os endpoints ficam sob https://api.simpliers.com.

Os comandos rodam no terminal. Troque {flowId} pelo id da automação e "smpl_..." pela sua chave. As requisições de publicar e despublicar não enviam corpo.

Listar automações
GET /api/v1/chat/flows?status=published
Apenas visualizar

Os parâmetros são separados por vírgulas. O parâmetro status=published retorna apenas as automações publicadas e status=unpublished apenas as despublicadas. Sem o parâmetro, todas as automações da conta são listadas. "limit" define o tamanho da página. O tamanho da página é 25 por padrão e 100 no máximo. O flowId vem também desta resposta.

curl -H "Authorization: Bearer smpl_..." \  "https://api.simpliers.com/api/v1/chat/flows?status=published"
Publicar uma automação
POST /api/v1/chat/flows/{flowId}/publish
Visualizar e gerenciar
curl -X POST -H "Authorization: Bearer smpl_..." \  "https://api.simpliers.com/api/v1/chat/flows/{flowId}/publish"
Despublicar uma automação
POST /api/v1/chat/flows/{flowId}/unpublish
Visualizar e gerenciar

Uma automação despublicada não roda até ser publicada de novo, e a configuração dela não é apagada.

curl -X POST -H "Authorization: Bearer smpl_..." \  "https://api.simpliers.com/api/v1/chat/flows/{flowId}/unpublish"

Códigos de resposta

Para os erros, a resposta traz um objeto error com os campos code e message. O code é estável, o texto do message pode mudar.

{  "error": {    "code": "missing_scope",    "message": "..."  }}
  • 403
    browser_origin_not_allowed
    Se a requisição tem um cabeçalho Origin, ou seja veio de um navegador, retorna um erro. A chave é usada apenas de um servidor.
  • 403
    missing_scope
    A chave não está no nível de acesso que este endpoint exige. Uma chave de apenas visualizar não pode mudar o estado.
  • 404
    flow_not_found
    A automação não foi encontrada. Uma automação de outra conta também retorna este código.
  • 429
    rate_limit_exceeded
    O limite de requisições foi excedido. A mesma requisição pode ser repetida um minuto depois.

Regras e limites

Regras para uma chave:

  • Limite de requisições
    120 requisições por minuto por chave, 300 por minuto por IP. Uma requisição acima do limite retorna 429 rate_limit_exceeded.
  • Escopo da conta
    Nenhum id de conta é enviado na requisição, e uma chave só vê as automações da própria conta.
  • Conta bloqueada
    Se account.effective na resposta for blocked, a automação não roda mesmo parecendo publicada. A requisição responde com sucesso e a automação não é disparada.
  • Rotação de chave
    O nome e o nível de acesso de uma chave não são editados depois. Você pode criar uma chave nova e mudar o valor no seu servidor.

O que é um contato ativo?

A cobrança é baseada em Contatos ativos: pessoas que se relacionam com você por meio de mensagens durante o mês. Automatizado ou manual, não faz diferença.

Responder comentários e a moderação de comentários não entram na sua contagem de contatos ativos. Você pode responder aos comentários das suas publicações sem limites, o contador só avança nas interações que viram um DM.

Acima do seu limite? Você fica no controle.

Suas automações continuam funcionando sem interrupção. Um pequeno excedente por contato é adicionado à fatura daquele mês para cada contato ativo adicional, então nada pausa inesperadamente.

Os contatos ativos são zerados no início de cada mês, tanto nos planos mensais quanto nos anuais. As cobranças de excedente são sempre faturadas mensalmente.

Faça o upgrade da sua assinatura antes de o mês terminar e quaisquer cobranças de excedente daquele ciclo são dispensadas.