API v1.0

API para Programadores

Integre o SignaGenius nos seus fluxos de trabalho existentes. A nossa API REST permite gerir programaticamente membros da equipa, ativar sincronizações e obter analíticas em tempo real.

Autenticação

Todos os pedidos à API devem ser autenticados usando um token Bearer. Pode gerar as suas chaves de API no Painel de Admin > Configurações > Programadores.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://panel.signagenius.com/api/v1/users

Endpoints

GET/users

Listar todos os membros da equipa e o estado da sua assinatura.

escopo: users:read?limit=1...200?offset=0...1000000
POST/users

Criar um usuário gerido do espaço de trabalho.

escopo: users:write
GET/users/{id}

Obter um usuário gerido no âmbito do locatário.

escopo: users:read
PATCH/users/{id}

Atualizar os campos de perfil suportados ou o estado da conta.

escopo: users:write
DELETE/users/{id}

Desativar um usuário de forma reversível mantendo o seu histórico de auditoria.

escopo: users:write
POST/users/batch

Criar, atualizar ou desativar até 100 usuários com resultados por linha e repetição idempotente.

escopo: users:writeheader: Idempotency-Key
GET/signatures

Listar os 200 artefactos de assinatura gerados mais recentes.

escopo: signatures:read?user_id
GET/change-requests

Listar os pedidos de alteração de perfil sujeitos a governação.

escopo: requests:read?status=pending|approved|rejected
GET/analytics

Recuperar analíticas de cliques em links para um intervalo de tempo específico.

escopo: analytics:read?days=1...365
GET/audiences

Listar os públicos de campanha reutilizáveis e os membros resolvidos.

escopo: audiences:read
POST/audiences

Criar ou substituir de forma idempotente um público gerido por API.

escopo: audiences:write
GET/audiences/{id}

Obter um público com os seus membros resolvidos.

escopo: audiences:read
PUT/audiences/{id}

Substituir um público e a totalidade dos seus membros.

escopo: audiences:write
DELETE/audiences/{id}

Excluir um público reutilizável.

escopo: audiences:write
GET/webhooks

Listar as assinaturas de webhook assinadas sem os seus segredos.

escopo: webhooks:write
POST/webhooks

Criar uma assinatura e receber o seu segredo de assinatura uma única vez.

escopo: webhooks:write
PATCH/webhooks/{id}

Atualizar, ativar ou pausar uma assinatura de webhook.

escopo: webhooks:write
DELETE/webhooks/{id}

Excluir uma assinatura de webhook.

escopo: webhooks:write
GET/export

Baixar uma exportação versionada da configuração do espaço de trabalho, sem credenciais, segredos, histórico de eventos ou artefactos reconstruíveis.

escopo: exports:read

Precisa de ajuda?

A nossa equipa de engenharia está aqui para ajudar com a sua integração.

Falar com Suporte