Channel-Scoped API Access through APIM
Live Platform now facilitates channel-scoped API integrations used in conjunction with Azure API Management (APIM). Previously, Live Platform API access was available only at the Service Provider (SP) level. Authentication tokens granted access to resources across all channels without any mechanism to restrict API operations to customers belonging to a specific channel. As a fast-track solution, channel integrations can now be routed through APIM instead of directly to Live Platform. APIM identifies the calling channel and adds a channel identifier header to requests forwarded to Live Platform. Live Platform then validates the channel context and retrieves only resources belonging to the requesting channel.
This feature is implemented using new channel-scoping header parameters: IAM Id of the channel (X-IAM-Account-Id) or the Live Platform channel Id itself (X-Ovoc-Channel-Id).
| ■ | When accessing Rest API with Channel admin permissions: If these request headers are not configured, the request will fail. |
| ■ | When accessing Rest API with Service Provider tenant level permissions: If these request headers are not configured, Live Platform maintains its existing behavior and processes requests with full Service Provider scope, allowing access to all system resources according to the token's permissions. |
The table below describes the endpoints and services support for these new request headers.
| ● | The code examples in the Rest API documentation links shown in the table below with the new request headers (described above) have been generated with Service Provider tenant level permissions. Later version of the Live Platform User's Manual for Channels will include a Rest API chapter with documentation for the supported requests. |
| ● | The Service Pack 4 Release will include an extended list of supported requests. |
|
Request |
Service Type |
||||||
|---|---|---|---|---|---|---|---|
|
Get All OC Leads |
|
||||||
|
Get Specific OC Lead for Customer |
|
||||||
|
Delete Consentless Lead |
|
||||||
|
Create OC Essential Service from Lead with Tenant Id Create OC Essential Service from Lead with IP Group |
|
||||||
|
Get Task |
|
||||||
|
Delete Service |
|
||||||
|
Get Operator Connect Customer Numbers V2 |
|
||||||
|
Get Operator Connect Customer Numbers V3 |
|
||||||
|
Get Specific Operator Connect Number |
|
||||||
|
Upload Operator Connect Numbers to Customer |
|
||||||
|
Release Operator Connect Numbers from Customer |
|
||||||
|
Unassign Numbers |
|