Docs

API guide

API examples describe integration patterns only and must stay aligned with implemented shield-api endpoints.

Details

Clear claims, explicit boundaries

Use environment-specific base URLs and API keys. Rotate keys with overlap windows so services can deploy safely.

Verify the signature header, timestamp and body bytes before accepting an event. Treat duplicate delivery as normal and process idempotently.

Predefine whether each flow fails open or closed, who is paged, and how manual approvals are handled during degraded operation.

POST /v1/decisions/login
Authorization: Bearer $SHIELD_API_KEY
Content-Type: application/json

{ "actorId": "usr_123", "environment": "staging" }