A API REST do Omnifox: introdução e requisitos de plano

O que é a API REST do Omnifox, qual plano você precisa (a partir do Crece), como autenticar com o cabeçalho X-API-Key e onde fica a documentação.

Jun 26, 2026

Veja este passo no vídeo · Requisitos: plano e permissões

O que é a API REST do Omnifox?

A API REST permite ler e criar os dados do seu workspace —contatos, conversas, mensagens, CRM, projetos— a partir do seu próprio código ou de uma ferramenta no-code. É a base para automatizar fluxos, sincronizar seu CRM ou construir integrações sob medida.

Este guia cobre o essencial para começar: requisitos de plano, autenticação e onde fica a documentação.

Requisitos de plano

O acesso à API é um recurso de plano chamado Acesso à API. Está disponível a partir do plano Crece (Crece, Escala e Exclusivo). Os planos Lite e Conecta não incluem.

Se seu plano não tiver, a seção Chaves de API ficará bloqueada e qualquer chamada à API responderá com o código PLAN_API_ACCESS_REQUIRED.

Antes de começar

  • Papel Administrador do workspace.
  • Um plano com Acesso à API.
  • Uma chave de API já criada (veja abaixo).

Passos

1. Crie sua chave de API

  1. Vá em Configurações → Chaves API → Nova chave de API.
  2. Dê um nome, escolha o workspace, uma data de expiração e marque só os escopos necessários: read:contacts, write:contacts, read:messages, write:messages, read:channels, read:crm, write:crm, read:projects, write:projects.
  3. Copie a chave na hora — ela só é exibida uma vez.

2. Autentique suas chamadas

Envie o token no cabeçalho Authorization: Bearer em cada requisição:

curl https://omnifox.io/api/v1/contacts \
  -H "Authorization: Bearer SEU_TOKEN_AQUI"

3. Conheça a URL base

Todos os endpoints ficam sob /api/v1/. Por exemplo: /api/v1/contacts, /api/v1/conversations, /api/v1/messages.

4. Leia a documentação

A referência interativa está em omnifox.io/docs, e a especificação OpenAPI em omnifox.io/api-docs/openapi.json para importar no Postman ou gerar um SDK.

Verificação

Uma chamada GET /api/v1/contacts com uma chave válida retorna 200 e um JSON com seus contatos. As respostas vêm envolvidas em { "success": true, "data": ... }.

Se não funcionar

  • PLAN_API_ACCESS_REQUIRED: seu plano não inclui Acesso à API. Faça upgrade para Crece ou superior.
  • 401: falta o cabeçalho Authorization: Bearer, ou a chave expirou ou foi revogada.
  • 403: a chave não tem o escopo necessário para aquele endpoint; edite-a e adicione o escopo.
  • 404 em um endpoint: lembre que a rota é /api/v1/..., não /v1/....

Dicas

  • Crie uma chave separada por integração e dê só os escopos mínimos.
  • Para receber eventos em tempo real (mensagens novas etc.) use Webhooks em vez de fazer polling.

Artigos relacionados

Isso foi útil?

Artigos relacionados

Fale conosco no WhatsApp