# Confirm the API contract before writing an integration

The client use case, required operations and the API documentation that comes with the Enterprise plan.

Updated October 15, 2026

## When you need this

A developer or a solutions engineer asked to integrate Elvina with an internal system, such as pushing completion records to an HR tool. It usually arrives as a scoping ticket with a two-week estimate. The risk is building against endpoints imagined from a marketing page and discovering the contract is different.

## Steps

An integration brief identifies authentication, objects, permissions, error states, idempotency and versioning questions that the real contract must answer.

- Write the client use case: which objects you need, such as learners, assignments or completion in the Learning Platform, and which direction data flows.
- List the questions the real contract must answer: authentication, objects and fields, permissions, error states, idempotency and versioning.
- Get the API documentation that comes with the Enterprise plan, and map each question to it.
- Build a small test against the confirmed contract before estimating the full integration.

## What you should see

A fictional hospice provider wants completion records in its HR system; today a person moves them, since Elvina does not write to external systems. The engineer drafts an integration brief with six questions and a read-only test of five completion records for one course. The brief goes to the product owner before any code is written.

- The brief lists the use case, the six contract questions and the five-record test with the expected HR field mapping.
- The product owner returns the confirmed specification or states which parts are not yet available.
- The engineer's estimate is based on the confirmed contract rather than on assumed endpoints.

## What to check before relying on it

API access with documentation is on the Enterprise plan; this page lists no endpoints, SDKs, credential flows or rate limits. Do not build against invented paths from a marketing example.

- The brief names objects and direction of data flow.
- Every contract question has an answer from the confirmed specification or a stated gap.
- A small test ran before the full estimate.

## If it does not work

API access with documentation is on the Enterprise plan, and this page lists no endpoints, SDKs, credential flows or rate limits. Do not build against paths inferred from examples on this site. The documentation that comes with the plan is the contract, and any operation that writes to an external system needs a permission decision on your side.

## Questions people ask

**Q:** Is there a public API today?

API access with documentation is on the Enterprise plan. Endpoints, authentication and limits are in that documentation, not on this page.

**Q:** What about idempotency?

Ask the contract how repeated requests are handled before you design retries. A nightly sync that duplicates records is worse than one that pauses.