One Platform exposes the Organizations API for partners and system integrators that need to integrate with organization-scoped platform capabilities.
The API is documented through the OpenAPI specification linked below.
| API | OpenAPI file | Audience |
|---|---|---|
| Organizations API | apis/oas/organizations.json | Partners and system integrators working on behalf of a One Platform organization. |
The Organizations API is scoped by organization.
Most endpoints follow this route pattern:
/v1/organizations/{id}/<resource>The {id} path parameter identifies the One Platform organization context for the request. The access token used by the integration must be allowed to operate on that organization.
The API currently covers organization-scoped operations for:
| Area | Examples |
|---|---|
| Business relations | Retrieve business relations and related consumer paths. |
| Consumers | Retrieve consumers connected to an organization and inspect consumer details. |
| Contracts | Create, retrieve, update, and manage organization contracts. |
| Contract items | Create and manage service lines connected to a contract. |
| Service activation | Retrieve activation group information and perform activation-related actions. |
| Consumptions | Retrieve latest and aggregated consumptions for consumers or business relations. |
| Product metrics | Retrieve product metrics for organization-related consumers. |
API calls use Bearer tokens issued by MyNamirial through OAuth2 Client Credentials.
For the authentication flow and token request examples, see Authentication.
The One Platform API base URL depends on the target environment and is provided during the integration setup.
Samples in this documentation use:
ONE_PLATFORM_BASE_URL="https://<one-platform-api-host>"Use the value provided for the environment you are integrating with.
- Authentication - OAuth2 Client Credentials with MyNamirial.
- Organizations API - OpenAPI reference for partner integrations.
- Integration Guides - task-based integration examples.