Getting Started
Follow this guide to begin calling APIs through our developer portal. Note that at a certain point in these steps, the user will need to contact an administrator for API access.
1. Navigate to the "Sign in" page in the developer portal
To access the "Azure Active Directory B2C" login button on the developer portal, locate and select the "Sign in" button, highlighted in red on the right screenshot.
Upon clicking, a pop-up will prompt the user to provide their login credentials.
2. Sign up for an account through the pop-up window
Initiate your account registration process by selecting the "Azure Active Directory B2C" button on the Sign in page, highlighted in red on the right screenshot.
Once clicked, a pop-up will emerge, prompting the user to enter their login information. Proceed through the steps outlined in the portal until your account creation is finalized.
3. Contact an administrator to obtain access to your APIs
Request access to your desired APIs by contacting an administrator. To review available APIs, navigate to the "APIs" tab.
In the event that no APIs are visible, seek assistance from an administrator to gain API access. Following their intervention, the API tab within the developer portal will populate with relevant APIs.
Upon contacting an administrator, they will proceed to grant you access to the desired APIs. Once this access is approved, the API tab within the developer portal will automatically populate with the corresponding APIs.
Testing APIs After Account Creation
After users have created an account and been assigned APIs, these APIs can be tested in the developer portal. The steps below outline how to test your APIs.
Note: For privacy reasons, the APIs in the sample images below are obscured.
1. Navigate to the APIs tag from the home menu
To locate the APIs, click on the "APIs" tab located in the top right corner of the home menu. If you've been granted access to specific APIs by an administrator, you should find them listed on this page. Choose an API to test.
If no APIs appear, it's likely that you haven't been granted access yet. In this case, reach out to an administrator to request API access.
2. Select an API and specify an operation
Once you've identified the desired API, navigate to the left side of the screen to select the specific operation you wish to test. Then, proceed to the right side of the screen and click on the green "Try It" button to initiate the request creation process.
3. Press "Send" on the sidebar to send your request
A sidebar will appear on the right side of the screen, displaying your subscription key along with fields for query parameters and headers. To send your request, simply click the "Send" button located at the bottom right corner of the screen.
