Get Started with Apps and Solutions
Prerequisites:
- You must have your access token.
- You, as a developer, must belong to a team that owns an app and an organization that owns a solution. You can use GetOrganizationsAssigned to retrieve a list of organizations and teams to which you belong.
You'll need an access token before starting the registration process for your app or solution. To generate an access token, you must create a Postman OAuth2.0 client. The steps below will guide you through setting up Postman and obtaining your access token.
Postman Collection Updates
You can download the latest version of the Developer API Postman collection here
Download the latest Developer API Postman collection and environment file below:
- Open Postman application and go to Collections > Import.
- In the dialog box, click files and select the Developer API postman_collection.json file you just downloaded.
- Once you've imported the file, you should see the latest version of the Developer API collection.
- Next, go to Environments > Import > Files and select the Apps API.postmant_environemnt.json file. This imports the environment variables that you'll use for the collection.
- The environment file includes the following hardcoded variables:
- {{baseURL}}: https://api.os1.dev
- {{ClientID}}: app::developerplatform
- Click on the root folder of the developer portal APIs and select the authorization tab.
- Select the type as OAuth 2.0 and fill out the details from the table below:
Field | Value |
|---|---|
Type | OAuth 2.0 |
Token Name | access-token name to save in postman |
Grant Type | Implicit |
Callback URL | none |
Auth URL | {{authURL}} |
Client ID | {{ClientID}} |
Scope | none |
State | none |
Client Authentication | Send client credentials in body |
Click Get Access Token to be routed to your organization login. You'll be routed back to Postman with your access token.
- Click Use Token.
- Click the token and select all and click Set as variable.
- Set it to the environment variable to {{DpToken}}.
Note: Always ensure your access token and other sensitive information are kept confidential. Avoid sharing them or posting them in public forums.
To register your app and soln, you'll l need your orgId and teamId.
Ensure you include the following header values in the Authentication tab.
- x-developerplatform-request-id:[ Your Request ID]
- x-developerplatform-access: [Your Access Token]
1. Call the Portal API Endpoint
Call GetOrganizationsAssigned.
2. Retrieve your orgId and teamId from the response:
Once you've sent the request, the API will return a list of organizations and teams you are a member of. From this list:
- Identify and note down the orgId for your desired organization.
- Similarly, locate the teamId for your specific team within that organization.
- Add your teamId and orgId to the Apps & Solns APIs environment to use in subsequent API calls.
