Using the API Developer Portal

How to run your API in the API Developer Portal

Prerequisites

Subscription to the API you want to use

Screenshot of API Developer A screenshot of the login page for the API Developer Portal. It displays a welcome message, a "Sign In" button, and a brief description of the portal's self-service functions for searching, viewing, and subscribing to APIs.

Step 1: Log into the portal

Access the API Developer Portal
- Production API Portal
- Dev/Test API Portal
- Sign in using your Functional Account

A screenshot of the "Subscriptions" page within the API Developer Portal. An arrow points to the selected "Subscriptions" tab in the navigation. The page shows details for the "Employee Information" API. A second arrow points down to the "API Key" section, where the key is redacted for security and a "Copy" button is visible next to it.

Step 2: Retrieve the API key

Click on Subscriptions at the top
Expand Application and click on the name of the API
Click Copy next to the API Key box (Do Not click the Generate Replacement API Key link unless you need to reset the key!)

Tip: If you are going to be trying several different APIs, open a second browser window to get the keys.

A screenshot demonstrating how to search for an API in the API Developer Portal's catalog. A sequence of arrows highlights the user's path: first, clicking the "API Catalog" tab; second, typing "Employee Information" into the search bar; third, clicking the "Search" button; and fourth, selecting the "Employee Information" API from the search results.

Step 3: Open the API window

Click on API Catalog on the top menu
Use the Search box to find the API by name
- Some APIs have multiple versions so be sure to select the one you subscribed to
- If you are in the Dev/Test API Portal, there may be Dev and Test versions; check the Environment field near the bottom of the API box to select the correct one

A screenshot of the API Developer Portal showing a pop-up modal window titled "Available authorizations". The modal displays two empty authentication options for the user to fill in: the first is for an "X-API-Key" with a blank "Value" field, and the second is for "basic" authentication with blank "Username" and "Password" fields.

Step 4: Authorize

Click on the REST tab
Click on the Authorize button
- Enter the API Key that you copied and click Authorize
- Enter your Boomi Account username and password and click Authorize
- Close the "Available authorizations" pop-up

A screenshot of the "Available authorizations" modal on the API Developer Portal, showing a successfully authenticated state. Both the "X-API-Key" and "basic" authentication sections are marked as "Authorized." For the API key, the value is masked with asterisks. For basic auth, the username is filled in, and the password is also masked with asterisks. Both sections now display a "Logout" button.

A screenshot of an API Developer Portal page for the "Employee Information" API. Several key elements are highlighted with blue boxes and an arrow to guide the user. An arrow points from the "API Catalog" tab to the page title. Further down, boxes highlight the "REST" tab, the "Base URL Path," and a "POST" method for the `/MultipleEmployeeJobPositionInformation` endpoint, indicating the necessary components for making an API call.

Step 5: Send the request

Expand the desired endpoint, then expand the GET or POST box
Click Try it out
- Enter values in place of "string"
- Click Execute
- View the response below the request area
  - A 200 status code indicates success
  - If no data is returned, the response will be empty but still show status code 200
  - Other response codes are listed on the REST tab in the API Catalog to assist with troubleshooting

Page updated

Report abuse