ISOPILOT DEVELOPERS · API V1

Integrate ISOPILOT without losing control over tenants, revisions and audit trails.

The Developer Area describes the operational scope of the Integration Hub: server-to-server authentication or Personal Access Tokens, least-privilege scopes, tenant-scoped APIs, candidate revisions, document locks and HMAC webhooks.

OpenAPI 3.0 JSON ↗Integration overview

BASE URL/api/v1

AUTHClient Credentials / PAT

WEBHOOKHMAC-SHA256

DOCUMENTICandidate revisions

RECOMMENDED FLOW

From credentials to a controlled revision.

1Create the clientThe company administrator assigns auth type, scopes and, if needed, an IP allowlist.

2Get a tokenUse Client Credentials for server-to-server integrations or a PAT for dedicated application access.

3Work inside the tenantProjects, documents and versions are always filtered to the company bound to the credential.

4Propose, do not overwriteExternal changes become candidate revisions and require acceptance before entering the document lifecycle.

AUTHENTICATION

Client Credentials example

The token endpoint issues a temporary bearer token. Real credentials should be stored in a secret manager, not in source code.

POST https://isopilot.it/api/v1/oauth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "...",
  "client_secret": "..."
}

DOCUMENT SCOPE

The integration does not directly modify an approved revision.

ETag / If-Match

The base-version hash makes it possible to detect concurrent changes before an external proposal is accepted.

Check-out / Check-in

A temporary lock reduces conflicts when a document is being edited by an external system.

Controlled promotion

Only acceptance in the ISOPILOT interface creates the new revision through the existing document service.

Available endpoints and methods are published in the machine-readable OpenAPI document. Capabilities actually available depend on the plan and entitlements assigned to the company.

ASSISTED INTEGRATION

Need to connect an ERP, DMS, portal or external workflow?

Describe the source system, events, objects to synchronise and security requirements: we can define scopes, webhooks and the revision model together.

Request an assessment →

DEVELOPERS · QUICK ANSWERS

Where is the ISOPILOT API documentation?

The Developer Area publishes the OpenAPI contract and explains authentication, scopes, version conflicts and candidate revisions.

Is there a machine-readable OpenAPI specification?

Yes. The API v1 contract is publicly available as OpenAPI 3.0 JSON at /openapi-v1.json.

Can API credentials see every company?

No. Each client is bound to a single company and resources are filtered to that tenant in addition to granted scopes.

How are edit conflicts handled?

Integrations can use hashes/ETags, If-Match and temporary locks; if the base has changed the proposal is not applied silently.