In order to view all of the associated documentation with this section you will need to be logged in with an account in the Pearson Developer Network which you can complete here.
The SMS API set leverages an OAuth 2 based flow to access the specified resources. As part of the onboarding process you will be provided a username and password credentials which you will use to generate the required access token in order to make calls in to the respective API set. Documentation on the token request resource can be found here.
Detailed within this section are the base URLs teams are expected to use within each environment as they interact with each of the services:
Access Token: https://int-piapi.stg-openclass.com/v1/piapi-pqa
This will be the base URL used to create access tokens in Pearson's pre-production environment.
Access Codes: https://grid-stg.pearson.com
This will be the base URL used to create codes in Pearson's pre-production environment for the associated ISBNs.
Access Token: https://piapi.openclass.com/v1/piapi
This will be the base URL used to create access tokens in Pearson's production environment.
Access Codes: https://api.pearson.com/sms-rest-api
This will be the base URL used to create codes in Pearson's production environment for the associated ISBNs.
Pearson provides access to these APIs to authorized integration partners that we have partnered with in order facilitate digital product fulfillment processes. To help facilitate this process the Pearson Developers Network team will work with you to get the proper credentials issued in order to begin leveraging the services. To start this process, you will need to send a request to our support alias at email@example.com and include the following information:
Your Company's Name:
Business Contact Full Name:
Business Contact Email Address:
Development Contact Full Name:
Development Contact Email Address:
Name Of Pearson Representative You Are Working With:
Once we have the required information on our end, we begin work on provisioning the access credentials which you will use to access the APIs. We'll do our best to expedite the process but the key provisioning process may take up to 3-5 business days to complete.
Once provisioning of your access credentials are complete you will receive three key pieces of information from our team:
Username and Password
The username and password values you receive will be used to generate access tokens within the specified environment. You will pass the generated access token within the header of your requests as documented within the SMS resource pages. Reference on how the username and password values are used can be reviewed within the Access Token section.
Note: Unique username/password values are assigned per environment so you will use a combination in the pre-production and production environments
Each integration partner will also be assigned a client ID value which will uniquely identify their application. Reference on how to use the client ID value can be reviewed within the Access Code section.
Note: This value will also be validated as part of the incoming request so if an invalid client ID is passed in the header of a request, the corresponding request will generate the applicable fault code.
Note: Unique client IDs are assigned per environment so you will use a different client ID in the pre-production and production environments.
To help you get up and running we've created a Postman collection for these APIs to make easier to get you up and running. You can review the details for setting up your Postman environment and collection here.
Included within your onboarding email will be a set of ISBN values that you can use for integration and verification purposes. Once you have completed the integration work on your end you will receive the listing of ISBN values that you can use for active production usage through your existing Pearson partner contact channels.