GOVERNANCE
API versions and changes
Keep the public API, payload contract, EDI profile and documentation revisions distinct.
Current identifiers
| Layer | Identifier |
|---|---|
| Public HTTP API | /api/ocean/v1 |
| Booking JSON schema | foryn.ocean.booking.v1 |
| Resolution schema | foryn.ocean.resolution.v1 |
| X12 mapping profile | X12_301_MSC_005030 |
| EDIFACT mapping profile | EDIFACT_IFTMBC_MSC_D99B |
| Partial batch | FORYN_EXTRACT_EVENTS_V1 |
| OpenAPI document | 3.1.0; API specification version 1.0.0 |
| Documentation revision | 2026-10-18 |
Compatibility rules
A documentation correction does not itself change the public API version. Breaking changes to request fields, mandatory status interpretation, or authentication require a new supported version and explicit migration guidance.
The public developer portal documents the implemented branch contract. Publication of these static docs does not confirm that a production Foryn Ocean API hostname is provisioned.
There is no invented public release history. This is the initial developer-portal documentation set.
API v1 · Fictional examples · Production access requires coordinated onboarding · OpenAPI contract ↗