Overview:
This article provides instructions for PTCB staff to validate API availability and functionality within the Azure Developer Portal. Staff who plan to use Azure APIM must receive a login email and password provided by Cobalt, this ensures better security by using OAuth. Vendors who plan to use the endpoints must also receive a login and password provided by Cobalt.
Signing into the Developer Portal (PTCB Staff and Vendors):
- Navigate to the Azure Developer Portal Home page.
- UAT Developer Portal: https://apimanagementservicetestv2.developer.azure-api.net/
- Production Developer Portal: TBD
- Enter your Email address and Password (provided by Cobalt).
- If you do not have an account provided by Cobalt, please open a support ticket asking for an admin to create an account for you. Once the account is setup by Cobalt, you will receive an email to reset your password and log in.
- Select Sign in.
Using the Developer Portal
View Endpoints:
Each Product corresponds to a unique API endpoint. PTCB Staff users will have visibility into all Products (endpoints). Vendors will only be able to see the products (endpoints) that have been assigned to them by Cobalt. For example, one vendor may have access to only the Certification endpoint, while another only has access to the Exam endpoint.
Logged in user will access to all products:
View and Test Endpoints:
To view and test and endpoint, click the APIs tab in the top ribbon, then select the endpoint that you would like to test.
You will then see the endpoint, which can be tested by clicking “Try this operation”
A popup window will display with the various parameters for this endpoint, as well as the ability to send a request through the browser.
Access Additional Endpoints:
To provide access to additional endpoints, Cobalt must be notified. Cobalt will then provide the user with a Subscription Key for a given Product (endpoint).
Reporting on Usage:
Each subscription key is assigned to a given vendor for a given endpoint. Using the Azure Developer Portal, PTCB will be able to report on usage per subscription. Vendors will not have access to view the usage for their own subscription.