Documentation center
Integration documentation
Every article follows the same structure: purpose, prerequisites, architecture, configuration, implementation steps, examples, testing procedure, troubleshooting and related documentation.
Getting Started
- Integration OverviewExampleHow the pieces fit: identity, provisioning, entitlement, delivery, results and certificates.
- AuthenticationExampleClient-credential token exchange, scopes, rotation and where secrets may live.
- Sandbox SetupExampleProvision an isolated environment, seed candidates and point webhooks at a local receiver.
- Integration ChecklistExampleThe go-live gate: identity, idempotency, revocation, observability, security review.
Identity
- OpenID ConnectVerifiedAuthorization code flow with PKCE, claim mapping and just-in-time provisioning.
- SAML 2.0VerifiedSP- and IdP-initiated federation, metadata exchange and attribute statements.
- User MappingExampleChoosing the correlation key that keeps two systems in sync for years.
- SSO TroubleshootingExampleA triage order for federation failures that resolves most tickets in minutes.
API
- API · UsersExampleCreate, upsert and resolve candidates by external identifier.
- API · AssignmentsExampleEntitlements: create, window, limit attempts and revoke.
- API · ResultsExampleReading scored attempts and their review state.
- API · CertificatesNeeds VerificationRetrieval, signed download URLs and the approval gate.
- Error HandlingExampleStatus codes, retry classes and how to avoid silent data divergence.
- Rate LimitsNeeds VerificationBudgeting request volume for bulk provisioning and reconciliation jobs.
Webhooks
- Webhooks · OverviewNeeds VerificationPush delivery of lifecycle events instead of polling.
- Webhooks · Events & PayloadsNeeds VerificationThe illustrative event catalogue used throughout this lab.
- Webhooks · SecurityNeeds VerificationSignature verification, replay windows and endpoint hardening.
- Webhooks · Retry Handling & TroubleshootingNeeds VerificationBackoff schedule, delivery history and recovering from an outage.
Integration Guides
- E-commerce CertificationExampleReference implementation: order to certificate, including refunds and expiry.
- LMS IntegrationExampleLaunch from a course and return the score to the gradebook.
- ATS IntegrationNeeds VerificationAssess candidates inside the hiring pipeline and write results back.
- Custom Portal IntegrationExampleBuild a bespoke portal against the REST and webhook contract.
Security
- Integration Security Best PracticesExampleThe controls security teams ask about before approving an integration.
- Credential ManagementExampleIssuance, storage, rotation and revocation of integration credentials.
- Audit LoggingExampleWhat to log on both sides so an incident can be reconstructed.
- Data ProtectionNeeds VerificationMinimisation, residency and proctoring-evidence retention.