API LocalEdge Guardian

Autenticacao

Todas as solicitacoes exigem sua chave API no cabecalho X-Api-Key.

curl https://avision.org/api/v1/guardian/subscriptions \
  -H "X-Api-Key: YOUR_API_KEY"

Endpoints

POST/api/v1/guardian/subscribe

Inscrever um perfil GBP em eventos webhook (e digest email opcional).

curl -X POST https://avision.org/api/v1/guardian/subscribe \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "gbp_id": "YOUR_GBP_ID",
    "profile_id": 123,
    "webhook_url": "https://yourapp.com/webhook",
    "events": ["hours_changed","status_suspended"],
    "notify_email": "you@yourcompany.com"
  }'

Expected response (201):

{
  "success": true,
  "subscription_id": 42,
  "gbp_id": "YOUR_GBP_ID",
  "events": ["hours_changed", "status_suspended"],
  "webhook_url": "https://yourapp.com/webhook",
  "created_at": "2026-10-08T10:00:00Z"
}

GET/api/v1/guardian/subscriptions

Listar todas as inscricoes ativas da sua chave API.

curl https://avision.org/api/v1/guardian/subscriptions \
  -H "X-Api-Key: YOUR_API_KEY"

DELETE/api/v1/guardian/subscribe/{id}

Desativar uma inscricao por ID.

curl -X DELETE https://avision.org/api/v1/guardian/subscribe/1 \
  -H "X-Api-Key: YOUR_API_KEY"

GET/api/v1/guardian/logs/{profile_id}

Obter logs recentes de entrega webhook de um perfil.

curl https://avision.org/api/v1/guardian/logs/123 \
  -H "X-Api-Key: YOUR_API_KEY"

GET /api/v1/guardian/proactive-hint/{profile_id}

Instant AI signal — no LLM call, sub-100ms response. Use this to power real-time CRM alerts.

curl https://avision.org/api/v1/guardian/proactive-hint/123 \
  -H "X-Api-Key: YOUR_API_KEY"

Response:

{
  "hint": "GBP hours changed 2 days ago — verify with your client immediately.",
  "trigger_key": "hours_changed",
  "urgency": "high",
  "lang": "en"
}

Error Codes

Code	Meaning	Action
401	Invalid or missing API key	Check X-Api-Key header
403	Quota exceeded or plan limit reached	Upgrade plan or wait for reset
422	Missing or invalid parameter	Check required fields in request body
429	Rate limit exceeded	Slow down requests — max 60/min
500	Server error	Retry after 30s or contact support

Use Cases

🔔

Slack alert on GBP change

Your client's GBP hours change → Guardian webhook fires → your server posts a Slack message instantly.

GBP Change → Guardian Webhook → Slack Alert

📊

CRM auto-task on suspension

GBP suspended → webhook triggers a CRM task assigned to the account manager within seconds.

GBP Suspended → Guardian Webhook → CRM Task

⚡

Real-time dashboard widget

Poll /proactive-hint every 60s to display live GBP health scores in your own client dashboard.

Poll /proactive-hint → Every 60s → Live Dashboard

Catalogo de eventos

Correspondencia entre nomes de eventos API e campos do Google Business Profile monitorados.

Evento	Campo GBP
`hours_changed`	`regularHours`
`title_changed`	`title`
`phone_changed`	`phoneNumbers`
`address_changed`	`storefrontAddress`
`website_changed`	`websiteUri`
`description_changed`	`description`
`categories_changed`	`categories`
`special_hours_changed`	`specialHours`
`open_status_changed`	`openInfo`
`service_area_changed`	`serviceArea`
`appointment_url_changed`	`url_appointment`
`appointments_changed`	`offers_online_appointments`
`location_changed`	`latlng`
`additional_categories_changed`	`additional_categories`
`competitor_overtake`	`competitor_overtake`
`status_suspended`	`suspension`

Payload webhook

Cada entrega e um POST JSON assinado com HMAC-SHA256.

{
  "event": "hours_changed",
  "gbp_id": "YOUR_GBP_ID",
  "profile_id": 123,
  "old_value": "Mon-Fri 9am-6pm",
  "new_value": "Mon-Fri 9am-8pm",
  "detected_at": "2026-10-01T10:00:00"
}

Headers recebidos

X-LocalEdge-Signature: <hmac-sha256>
X-LocalEdge-Event: hours_changed

Digest email (opcional)

Passe notify_email na inscricao para tambem receber emails HTML de alerta via LocalEdge.

{
  "gbp_id": "YOUR_GBP_ID",
  "profile_id": 123,
  "webhook_url": "https://yourapp.com/webhook",
  "events": ["hours_changed","status_suspended"],
  "notify_email": "you@yourcompany.com"
}

Solicitar acesso API

Obrigado! Entraremos em contato em breve.

Em breve

Mais APIs LocalEdge estao no roadmap.

Heatmap API Em breve

GBP Score API Em breve

AVI Content API Em breve