API Wiri Connect

Uma API REST orientada para leitura para extrair dados do Wiri para sistemas de terceiros, painéis e integrações. Disponível nos planos Enterprise.

Apenas Enterprise. A API Wiri Connect está disponível no plano Enterprise. Para gerar uma chave API, vá a Definições → Acesso API na sua conta Wiri.

Autenticação

Cada pedido deve incluir a chave API no cabeçalho Authorization como token Bearer:

# Exemplo com curl
curl https://seu-dominio.com/api/v1/items \
  -H "Authorization: Bearer wk_sua_chave_api"

Se a chave estiver em falta ou for inválida, a API devolve 401 Unauthorized:

{
  "error": "Invalid API key."
}

URL base

Todos os endpoints são relativos à raiz da sua instalação Wiri:

https://seu-dominio.com/api/v1/

Endpoints

MétodoEndpointDescrição
GET /api/v1/items Listar todos os artigos do menu
GET /api/v1/contacts Listar todos os clientes / contactos
GET /api/v1/invoices Listar faturas — suporta ?status, ?from, ?to
GET /api/v1/sales Listar vendas da caixa — suporta ?status, ?from, ?to

Formato de resposta

Todas as respostas bem-sucedidas devolvem 200 OK com um corpo JSON contendo dois campos:

{
  "data": [ /* array de objetos */ ],
  "count": 42
}

GET /api/v1/items

Devolve todos os artigos do menu da sua conta, ordenados alfabeticamente.

GET /api/v1/contacts

Devolve todos os contactos (clientes) da sua conta, ordenados por nome.

GET /api/v1/invoices

Devolve faturas ordenadas por data decrescente. Suporta os seguintes parâmetros de consulta:

ParâmetroTipoExemploDescrição
statusstringPaidPaid, Unpaid ou Overdue
fromdata2026-01-01Início do intervalo de datas (inclusive)
todata2026-01-31Fim do intervalo de datas (inclusive)

GET /api/v1/sales

Devolve vendas da caixa ordenadas por data decrescente. Suporta os mesmos parâmetros que as faturas, com status aceitando paid ou voided.

Respostas de erro

Estado HTTPCorpoQuando
401{"error": "Invalid API key."}Chave em falta, errada ou revogada
401{"error": "Missing or malformed Authorization header."}Cabeçalho ausente ou não no formato Bearer
404{"error": "Unknown endpoint."}Nome de recurso não na lista permitida

Gerar uma chave API

  1. Inicie sessão na sua conta Wiri (plano Enterprise necessário).
  2. Vá a Definições → Acesso API.
  3. Clique em Gerar chave API. A chave começa com wk_.
  4. Copie a chave imediatamente — é mostrada na íntegra apenas uma vez após a geração.
  5. Para rodar a chave, clique em Regenerar chave. A chave antiga deixa de funcionar imediatamente.
Mantenha a chave secreta. Qualquer pessoa com a sua chave API pode ler todos os dados do seu negócio. Não a inclua em controlo de versão nem a exponha em código do lado do cliente.

Ver também: Definições · Visão geral do Wiri Connect