API & Integrações
Chaves API
Onde: /dashboard/settings/api-keys
As chaves API permitem que os seus sistemas externos (ERP, e-commerce, ferramentas internas) consultem a plataforma ZIQY DPP.
Criar uma chave
- Clique em Criar uma chave.
- Atribua-lhe um nome explícito (ex.
Production,Staging,CI/CD). - Indique uma duração de expiração em dias (deixar em branco = sem expiração).
- Valide — a chave é apresentada uma única vez; copie-a imediatamente para um gestor de segredos.
Informações apresentadas para cada chave
| Coluna | Descrição |
|---|---|
| Prefixo | Os primeiros caracteres da chave (ex. dpp_live_xxx****) |
| Estado | Ativa ou Revogada |
| Criada em | Data de criação |
| Última utilização | Último pedido autenticado |
| Nº de utilizações | Contador total de pedidos |
| Limite | Número de pedidos autorizados por minuto |
Utilização funcional
Os pedidos devem transmitir a chave no cabeçalho HTTP Authorization: Bearer <a_sua_chave>. O URL de base da API é https://dpp.ziqy.co/api/v1.
⚠️ Importante
- Nunca partilhe uma chave num e-mail ou num repositório de código público.
- Guarde-a nas variáveis de ambiente dos seus sistemas.
- Em caso de suspeita de comprometimento, revogue imediatamente a chave e crie uma nova.
- Utilize chaves distintas por ambiente (produção, staging, testes).
Revogar uma chave
Clique no ícone do caixote do lixo à frente da chave em questão e confirme. A revogação é imediata e irreversível.
Webhooks
Onde: /dashboard/settings/webhooks
Os webhooks permitem que o seu servidor receba uma notificação HTTP automática a cada evento ocorrido na plataforma.
Criar um webhook
- Clique em Criar um webhook.
- Introduza o URL do seu endpoint (deve começar por
https://). - Selecione os eventos a monitorizar (agrupados por categoria):
| Categoria | Eventos disponíveis |
|---|---|
| Produtos | Criado, Atualizado, Eliminado, Publicado |
| DPP | Criado, Publicado, Atualizado |
| Códigos QR | Lido, Criado |
| Conformidade | Alerta, Verificação concluída |
| Reparações | Submetida, Concluída, Atualizada |
| Artigos | Criado, Ciclo de vida modificado |
- Valide — um segredo de assinatura é apresentado uma única vez; copie-o imediatamente.
Cabeçalhos enviados pela plataforma
| Cabeçalho | Conteúdo |
|---|---|
X-DPP-Signature | Assinatura HMAC-SHA256 do payload com o seu segredo |
X-DPP-Event | Nome do evento (ex. repair.completed) |
X-DPP-Timestamp | Carimbo de data/hora do envio |
💡 Sugestão — Verifique sempre a assinatura HMAC do lado do servidor antes de processar o evento, para se certificar de que o pedido provém efetivamente da plataforma ZIQY.
Ativar / desativar um webhook
Utilize o botão de alternância (ícone de energia) à frente de cada webhook para o colocar em pausa sem o eliminar.
Fila de erros (DLQ)
Em caso de falha repetida de um envio, consulte a fila de mensagens em erro em /dashboard/settings/webhooks/dlq.