Core Network APIs
Introduction to the Core Network REST APIs
Welcome to the documentation for the Mobility Services REST APIs. This collection of APIs allows for the provisioning and management of subscriber services, handling various operations related to subscription profiles, SIM import, and more. The APIs are designed to be straightforward and intuitive, encapsulating complex telecommunications operations into simple API calls.
Overview
The APIs are grouped into two main categories:
Subscription Profile And Provisioning: This set of APIs covers a broad range of functionalities related to subscriber profiles. Through these APIs, you can retrieve information about a subscription, activate a new subscription, update existing subscriptions, change SIMs, block or unblock SIMs, change MSISDN, terminate subscriptions, and more. It supports a variety of parameters and configurations allowing for a flexible management of subscriber services.
SIM Import (BETA): This API facilitates the import of SIMs to the Mobility Services platform. It provides the ability to specify essential SIM attributes like BSSID, ICCID, IMSIs, and cryptographic keys for provisioning SIMs. Please note that this SIM import API is not stable and is subject to change.
Authentication and Authorization
The APIs support OAuth2 Client Credentials flow for authentication, where clients can obtain a token from the specified token URL. Different scopes are defined for reading and writing subscription information, as well as importing SIM data.
Error Handling
Standard HTTP status codes are used to indicate the success or failure of an API request. Specific error schemas are defined to provide more information about the error, including a description of the error and additional details if applicable.
Rate Limiting
The APIs have built-in rate limiting to ensure fair usage and to protect the system from abuse. Responses include standard headers to indicate the current rate limit status.