The Atlas platform exposes some of it's functionality to trusted integration partners through the Atlas API subsystem. The Atlas API consists of several distinct services forming logical groupings of functionality.
The Atlas API system is composed of the services shown in the following table. Direction is from the point of view of Atlas. Services marked as IN originate with the partner application and connect to the Atlas API system. Services marked as OUT originate with Atlas and connected to an endpoint hosted as on the partner system.
| Service Name | Direction | Use Case | Required Role | Prerequisites | Version |
|---|---|---|---|---|---|
| Getting Started | IN | psiGettingStarted | None | ||
| Eligibility | IN | psiEligibility | |||
| Test Center | IN | psiTestCenter | |||
| Test Center Notification | OUT | N/A | |||
| Test Publication | IN | psiTestPublication | |||
| Booking | IN | psiBooking | |||
| Booking Notification | OUT | N/A | |||
| Payment | IN | psiPayment | |||
| Voucher | IN | psiVoucher | |||
| Proctoring | IN | psiProctoring | |||
| Proctoring Results | OUT | N/A | |||
| Proctoring Results Notification | OU | N/A | |||
| Assessment Results | OUT | N/A | |||
| Assessment Results Notification | OUT | N/A |
The Atlas API endpoints are exposed through a comprehensive API management system.
Partner facing functionality is exposed through the API Store. The API Store is a web portal integration partners use to access our Swagger-based API references, documentation, interactive API console, production and sandbox APIs, and client SDKs. The API Store is also used to subscribe to the API services for building their business applications.
API consumers need access tokens to invoke APIs subscribed under an application. Access tokens are passed in the HTTP header when invoking APIs. The API Manager provides a Token API that you can use to generate and renew user and application access tokens. The response of the Token API is a JSON message. You extract the token from the JSON and pass it with an HTTP Authorization header to access the API. The API Store provides a graphical interface for creating your keys.
Access to the Atlas API subsystem is restricted by IP address. This is in addition to the the OAUTH2 credentials and tokens used to secure the individual endpoints that are obtained through the API Store and/or the Token API. In addition, each service except for the Getting Started Service implements role-based authorization. The user account associated with the access token must be assigned the correct role for each service. Not all integrations will need to consume all services.
The API Store only displays the services for which your account is authorized to access.
The Gettting Started Service is the first service exposed to partners. It's role is to introduce you to the system while your Atlas account is being configured. The Getting Started Service lets you check connectivity, create your application within the API Store and subscribe to the Getting Started Service, learn about using the Token API for obtaining and refreshing access tokens.
Each partner will be assigned an implementation coordinator to help navigate through the Atlas API subsystem and supporting flows. The API Store should provide the necessary documentation and examples for working with the system. The implementation coordinator will involve additional technical resources into the process as necessary to ensure a successful integration.
Your implementation coordinator will provide three pieces of information:
The first generation Atlas API subsystem requires the account code be passed in the parameters for many of the API calls. The second generation subsystem determines the account code from the account associated with the access token. This has simplified the syntax for many API calls.
Once you are provided with these three items, you can log into the API Store and get started. The Getting_Started service contains the documentation you need to get started working with the Atlas API system.