V-Shield API

Integrate V-Shield into your workflows with our REST API.

POST/api/endpoints/agent-enroll.php

Agent enrollment on the site. Registers the agent and links it to the site.

Authentication: Agent API key (site_id + secret)

POST/api/endpoints/agent-heartbeat.php

Heartbeat sent by the agent to signal it is active.

Authentication: Agent API key (site_id + secret)

POST/api/endpoints/agent-fetch-jobs.php

Fetch pending jobs for the agent (scans, updates, etc.).

Authentication: Agent API key (site_id + secret)

POST/api/endpoints/agent-report-result.php

Report the result of a job executed by the agent.

Authentication: Agent API key (site_id + secret)

POST/api/endpoints/onboard.php

Onboard a new client after Stripe payment.

Authentication: Stripe webhook (verified signature)

Full documentation coming soon. Contact us for early access.