Iniciar sessãoIniciar teste gratuito
easyCoexistence APIs oficiais

API de redes sociais multi-tenant: uma chave de API, muitas contas de clientes

A Partner API da easyCoexistence é multi-tenant por conceção: uma chave ec_live_ na sua conta liga e gere os números de WhatsApp e as contas sociais de muitos clientes. Cada ligação transporta o id do seu cliente como external_ref, tem o token próprio desse cliente, um destino de webhook próprio e aparece nos eventos de estado assinados, por isso GET /channels?external_ref= lista as contas de um só cliente.

200 characters

Comprimento máximo de external_ref que uma sessão de ligação aceita: o id próprio do cliente, guardado na ligação que a sessão cria.

1 key

Chaves de API que uma conta da easyCoexistence pode ter em simultâneo; chaves separadas significam contas separadas, com faturação separada.

50 open

Sessões de ligação que uma conta pode ter abertas em simultâneo, a par de um limite de 100 novas sessões por hora.

5 minutes

Idade a partir da qual o carimbo temporal de um evento assinado deve ser rejeitado, comparando o HMAC em tempo constante.

Como é que uma conta serve muitos clientes?

A sua conta na easyCoexistence representa o seu produto, e cada cliente é uma etiqueta nas ligações que traz. Os clientes não criam conta própria, nunca veem a sua chave e são faturados por si, e não pela easyCoexistence:

Your accountOne ec_live_ key, one bill, one status events URL
Your customerYour own id, sent as external_ref
NumberA WhatsApp number at /connections
ChannelA social account at /channels
DestinationA webhook per number or channel

Como é que marca cada ligação com o seu cliente?

Envie external_ref na sessão de ligação. O valor é guardado no número ou canal que a sessão cria, acrescentado ao redirecionamento e incluído nos seus eventos de estado. Um início de sessão no Facebook ou no LinkedIn que traga várias Páginas etiqueta cada uma. Para ver as contas de um cliente, filtre qualquer uma das listas:

One customer's social accounts and numbers
curl "https://easycoexistence.com/api/v1/channels?external_ref=customer_4821" \
  -H "Authorization: Bearer $EC_API_KEY"

curl "https://easycoexistence.com/api/v1/connections?external_ref=customer_4821" \
  -H "Authorization: Bearer $EC_API_KEY"

Como são mantidos separados os tokens dos clientes?

Cada ligação guarda o token do respetivo cliente. O token de um número de WhatsApp é o token de negócio que a Meta emite no Embedded Signup, limitado aos recursos desse cliente, e o token de uma conta social é o que o seu titular concedeu. As credenciais só chegam através da sua chave, a partir do seu backend, e um ID que não esteja na sua conta responde 404 not_found. Procure a ligação do cliente a que um trabalho pertence antes de obter o respetivo token, para que o trabalho de um cliente nunca corra na conta de outro.

Como funcionam os webhooks por cliente?

Um destino por conta, escolhido por si. Aponte os canais para um único URL e encaminhe com base no account_id do corpo, ou dê a cada cliente um URL próprio. Cada canal assina com o seu próprio segredo, definido em PUT /channels/{id}/webhook, por isso o account_id indica com que segredo deve verificar. As mensagens de um número vão da Meta para o seu webhook_url, definido na conta de WhatsApp Business, por isso encaminhe-as com base no phone_number_id.

Como é que os eventos de estado indicam o cliente a que dizem respeito?

Trazendo o seu external_ref. Um URL de eventos por conta recebe os eventos connection.* e channel.*, cada um com a vista de ligação ou de canal no interior, incluindo external_ref, e post.published e post.failed trazem a publicação e o respetivo canal. Os eventos são assinados com o segredo próprio da conta em X-EC-Signature e reenviados quando o seu endpoint falha, por isso trate cada id de entrega uma só vez.

Com que rapidez pode integrar muitos clientes?

Com 50 sessões de ligação abertas e 100 novas por hora, por conta. A Meta conta cada primeira integração de WhatsApp contra um limite a nível da aplicação, partilhado por todas as contas da easyCoexistence, e os limites impedem que a importação de uma plataforma o esgote. Crie cada sessão quando o respetivo cliente estiver prestes a ligar, e um limite responde 429 cap_reached ou rate_limited.

E se a conta de um cliente já estiver ligada noutro lado?

O início de sessão é recusado. Uma conta social liga-se a uma conta da easyCoexistence de cada vez, por isso, se outro serviço que use a easyCoexistence a detiver, o last_error da sessão indica-o e o cliente remove-a aí ou inicia sessão com outra conta. Dentro da sua própria conta, um cliente pode ligar quantas contas precisar, cada uma etiquetada com o mesmo external_ref.

Como é que retira um cliente?

Liste as ligações e os canais do cliente por external_ref e elimine cada um com DELETE. Remover um número revoga o acesso da easyCoexistence na Meta e interrompe a monitorização; remover um canal revoga o acesso na rede e cancela as publicações que ainda aguardam na fila. A faturação de cada uma cessa no fim do ciclo, e as restantes ligações do cliente, tal como as de outros clientes, ficam intactas.

Erros comuns

  • Usar um e-mail como external_ref. Os e-mails mudam e o valor fica guardado em cada ligação, por isso use o id estável da sua própria base de dados.
  • Verificar eventos reencaminhados com o segredo de outro cliente. Procure o segredo pelo account_id do corpo, já que cada canal assina com o seu próprio.
  • Enviar links de ligação a toda a sua base de clientes de uma vez. Só podem estar abertas 50 sessões por conta, por isso convide os clientes em vagas.
  • Eliminar um cliente só na sua base de dados. As ligações do cliente continuam na sua conta e na sua fatura até que cada uma seja removida através da API.
Fazer isto com a EasyCoexistence

A easyCoexistence permite que uma só chave de API sirva toda a sua base de clientes: os números de WhatsApp e as contas de Instagram, Facebook, TikTok, YouTube, LinkedIn e outros canais, cada um etiquetado com o id do seu cliente, com token, webhook e eventos assinados próprios, e cada ligação monitorizada 24/7. De US$ 9 a US$ 0.75 por ligação por mês, descendo à medida que acrescenta ligações, com os primeiros 3 dias gratuitos.

Perguntas frequentes

Preciso de uma conta da easyCoexistence por cliente?

Não. Uma conta e a respetiva chave podem ter as ligações de vários clientes, distinguidas por external_ref. Só são precisas contas separadas quando quiser faturação separada.

Os meus clientes podem ver as contas uns dos outros?

Não através da easyCoexistence. Nunca têm a sua chave e abrem apenas os seus próprios links de ligação. O que cada cliente vê dentro do seu produto é decidido pelo seu código.

Posso dar a cada cliente um URL de webhook diferente?

Sim. Cada número e cada canal aceita um destino próprio, por isso funciona tanto um URL específico do cliente como um URL partilhado encaminhado pelo account_id.

Como é faturada uma conta multi-tenant?

Por ligação, somando todos os seus clientes: de US$ 9 a US$ 0.75 por ligação por mês, definido pelo escalão do seu total, com os primeiros 3 dias gratuitos.

Continue a ler

Ligue o seu primeiro canal em dois minutos.

Sem revisões de plataformas para esperar. Ligue o WhatsApp, o Instagram, o TikTok ou outro canal, peça depois à sua IA que publique, responda ou faça um relatório, e veja-a trabalhar.

  • 3 dias grátis
  • Cancele quando quiser
  • Só APIs oficiais
  • Monitorizado 24/7

Verificado em