Developers
Authentication
How sessions, API clients, and account scoping work.
WorkOrderGuard's API is authenticated. This page covers the concepts you need before calling it.
Two ways to authenticate
- Web session. The WorkOrderGuard app authenticates you interactively and calls the API on your behalf.
- API clients. Programmatic access uses API clients — machine credentials scoped to an account. If your account uses API clients, they are provisioned for you; there is nothing to create in the app.
Account scoping
Many operations are scoped to an account. API requests may need to identify the account being operated on via a selected-account header. The signed-in in-app API explorer lets you supply the account context for secured requests. The public API reference lists only the publicly documented operations.
Trying the API
The WorkOrderGuard app includes an API explorer at /api-docs. It documents the current
API contract and lets you issue secured requests through your signed-in web session.
Sign in first, then open the explorer from the app. For the publicly documented surface,
see the API reference.