Pular para o conteúdo
Fale com a gente
API para desenvolvedores · acesso antecipado

A fila do balcão dentro do seu sistema

A API do Vinki liga a fila e o WhatsApp do estabelecimento a outros apps: o sistema de gestão, o prontuário, o PDV ou um app próprio do cliente. Você cria e chama senhas, fala com quem espera e recebe os eventos de volta.

Pedir acesso antecipadoVer as rotas

Chave por estabelecimento

Cada loja gera a própria chave no painel do gerente, com escopos (senhas, mensagens, protocolos) e pode revogá-la a qualquer momento.

WhatsApp sem expor credenciais

O Vinki envia pelo número que a loja conectou. A credencial da Meta nunca sai do Vinki e nunca passa pela sua aplicação.

Webhooks assinados

Eventos enviados ao seu endereço com assinatura, repetição automática e chave de idempotência para não processar duas vezes.

Rotas

O essencial do atendimento

POST
/v1/senhas

Cria uma senha numa fila; com whatsapp, já liga o acompanhamento do cliente.

GET
/v1/senhas/{id}

Situação da senha: aguardando, chamando, em atendimento, concluída.

POST
/v1/senhas/{id}/chamar

Chama a senha num guichê ou sala; o painel anuncia e o cliente é avisado.

POST
/v1/senhas/{id}/solicitacoes

Envia uma solicitação do atendente ao cliente (documento, foto, confirmação).

POST
/v1/protocolos

Abre um protocolo ligado à senha ou ao cliente e devolve o código.

POST
/v1/mensagens

Envia uma mensagem de modelo aprovado ao cliente de um atendimento.

Webhooks

evento
senha.chamada

Uma senha foi chamada (número, fila, guichê).

evento
senha.concluida

O atendimento terminou; inclui a nota, se houver.

evento
mensagem.recebida

O cliente respondeu na conversa do atendimento.

evento
protocolo.atualizado

Um protocolo mudou de situação.

exemplo em curl
# cria a senha e liga o WhatsApp do cliente
curl https://api.vinki.me/v1/senhas \
  -H "Authorization: Bearer $VINKI_CHAVE" \
  -H "Idempotency-Key: pedido-48213" \
  -d '{"fila":"geral","whatsapp":"5519999990000"}'

# resposta
{ "id": "sen_8f2k", "numero": "A015",
  "situacao": "aguardando" }

# pede um documento enquanto o cliente espera
curl https://api.vinki.me/v1/senhas/sen_8f2k/solicitacoes \
  -H "Authorization: Bearer $VINKI_CHAVE" \
  -d '{"texto":"Envie uma foto do pedido médico"}'

# webhook recebido pelo seu sistema
POST https://seu-sistema/webhooks/vinki
X-Vinki-Assinatura: t=1793795762,v1=…
{ "tipo": "senha.chamada", "numero": "A015",
  "guiche": "3" }
Acesso antecipado. A API está sendo aberta para os primeiros parceiros. Nomes de rotas e campos podem mudar até a versão 1 ser publicada; quem estiver no acesso antecipado é avisado antes. Uso sujeito aos Termos de uso e à Política de privacidade, e as mensagens seguem as políticas do WhatsApp Business.