Documentation

Understand the authority boundary before you integrate.

PipKey integrations should ask the licensing service for decisions rather than reimplementing licensing state inside the product.

Integration model

PipKey exposes a versioned JSON-over-HTTPS API under /v2. Protected routes use explicit authentication and scope checks, while retryable mutations use idempotency where supported.

Typical product flow

1. Product identifies itself to PipKey
2. Product supplies the licence/installation context
3. PipKey resolves current authoritative state
4. PipKey enforces activation and lifecycle policy
5. Product receives a decision or signed assertion
6. PipKey records relevant audit/outbox evidence

Production boundaries

Production interactive API documentation is intentionally disabled under the accepted 1.0.0 controls. Integration details should be taken from reviewed route schemas and controlled customer/developer material.

Environment separation

Machine credentials distinguish live and test environments. Integrations must supply the expected environment and should use the least privilege scope needed for the task.

Need integration access?

Request controlled access and the relevant integration material from PluginPip.

Request access