Standards your API speaks
An API can also speak outside Standards, such as SCIM for a Customer's directory, by mapping each Standard's operations onto the Startup's own Verbs.
An API can also speak a Standard: an outside spec its callers already use. The Startup maps the Standard's operations onto its own Verbs, and the platform's translator does the rest.
Why a Customer asks for one
Harbor Residential's identity provider adds and removes its staff with SCIM 2.0. Leaseline's API speaks SCIM, so Harbor Residential points its provider at Leaseline's SCIM path, and each change reaches Tenant.invite and the membership Verbs. Nobody at Leaseline writes a route.
What a translated call gets
The translator takes the request in the Standard's shape and runs the mapped Verb as an ordinary Action.
| On every translated call | Detail |
|---|---|
| Keys and Permissions | Checked as on any route |
| Limits and Meters | The same Limits apply, and usage meters against the caller's plan |
| Events | One Action and its Events, kept forever |
| Errors | Each refusal in the Standard's own error shape |
The Standard's path sits on the Startup's own API host, under its Publication, such as /scim/.
Standards the platform speaks
| Standard | Callers | Maps onto |
|---|---|---|
| SCIM 2.0 | A Customer's identity provider | Tenant.invite and membership Verbs |
| Chat completions | Model clients calling an Agent sold as a Product | The Agent's own Verb |
| S3 | Clients that read and write stored objects | File Verbs |
| OIDC discovery | Clients signing in to a Startup | The Startup's sign-in |
| RSS | Feed readers following a Site | Page lists |
| Standard Webhooks | Receivers verifying deliveries | Every Watch delivery |
An Interface declares each one in conformsTo. Standards shows the mapping in code.