Onboarding and Ordering Operate API

The Onboarding And Ordering API enables Channel Partners and Marketplace providers to carry out onboarding and ordering tasks via an headless operate API. Status updates are delivered via HTTP notifications to inform the service requester of state changes throughout the process.

This API follows the TMForum 931 standard as described in the GSMA Open Gateway playbook.

It can be used for

• Channel partner and marketplace integrations.

• Automated end customer onboarding.

• Placing orders to access API products and services.

• Receiving status updates via HTTP notifications.

API Information

Endpoints

How it works

There are 3 parties involved in the use of this API:

• Application Service Provider (ASP): the end customer who wishes to embed an API service in their web or mobile application.

• Channel Partner (CP): the aggregator or marketplace provider who offers access to multiple mobile operator's API based products and services to the ASP. Channel Partners ensure coverage across multiple Mobile Network Operators (MNO) in the required countries.

• Communication Service Providers (CSP): the MNOs who provide the underlying service via API in the countries in which they operate.

A typical interaction across the involved parties could include:

1. An end customer (ASP) wishes to order a new API based service, such as Identity or Quality on Demand, for their web or mobile application.

2. The ASP approaches an aggregator CP to access the service across all the CSPs that provide coverage in the required country. The ASP registers with the CP and places an order for the service via their website.

3. The CP's platform sends the request to the Onboarding and Ordering API provided by each of the CSPs in the chosen country.

4. The CSP processes the request. For example, it activates the "Quality on Demand" service and provides updates back to the CP via HTTP notifications.

5. The CP provides the live access credentials to the ASP who can now use the service in their live application.

Run in Postman

To begin using the Vodafone workspace in Postman, please follow the steps below to create a set of credentials that can be used with our sandbox collections:

• Register an account on https://developer.vodafone.com and create a sandbox app for the APIs that you are interested in.

• Use the Client Key and Secret from your sandbox app to populate the relating variables in the "Sandbox Credentials" environment group in Postman.

• Call the token endpoint to create a bearer token that is used in the API resource endpoint. Your client credentials will be taken from the environment variables and used in a basic OAuth flow.

• You need to call the token end-point for each API as the API scope is held in the request body of the token call.

• The last bearer token and trace ID will be stored in collection variables associated with the API solution that you have chosen.

• You can use these collections as read-only or create a fork into your own personal workspace to edit the details.

You can access all of Vodafone's sandbox APIs in our Postman workspace by clicking the link below:

Run in Postman

What is Postman?

Postman is a popular development and testing tool that is widely used across the API developer community. It offers an easy to use interface for making HTTP requests, testing API responses and collaborating with team members. For more details, see postman.com.