Create an API Product

To group relevant APIs, you need to create an API Product and add API proxies (instances of API) to the product. Creating an API product makes your API discoverable and consumable.

Before you create an API product, you must have:

• A team admin or Trimble developer role.

To create an API product, complete the following tasks:

Add a product

To add a product:

1. From the Trimble Developer Console left menu, select API Management > API Products.
2. On the top right corner, click + ADD PRODUCT. The CreateProduct page displays the About section.

Complete the API Product About section

1. From the left menu in the Trimble Developer Console, select API Management > API Products. A list of API products displays.

2. Select + Add Product (upper right of the window). The Create Product Page displays.

3. Provide the following information about your product:

   • Name: Enter the name of the API product. This is used for internal reference. You cannot edit the name after the API product is created and published.
   • Display Name: This is the name that appears on the Trimble Developer Marketplace. You can edit the  Display Name at any time. If you do not specify a name, the field will default to the Name value.
   • Description: Enter a short description of the API product.

4. Select Continue to define the API type.

Define your API Type

API publishers use types to categorize APIs by similar attributes. You can select the API Type from a pre-defined list. Consumers can filter their search by API Type and quickly locate APIs of interest.

1. In the API Type section, select one or more pre-defined types from the API Type list.

   

2. Select Continue to add proxies, or use the Back button to review the About section.

Add or create your API Proxies

The Proxies section is where you can add any proxies you have created. If no proxies have been created, use the + ADD PROXY button to add an API proxy.

1. Select the API Proxy from the list or create a new Proxy. See Create an API Proxy for details.

   

2. Select Continue to add product visibility and compliance details or select Back to return to the previous section.

Complete your product visibility and compliance details

To define who can see your product and add compliance details:

Product details is where you specify the visibility of your product and the compliance of your product.

1. In the Visibility section, select an option that fits your needs.

   Visibility controls which user community users can see the API Product. There are three options: Team, Sector, or Everyone at Trimble. For more details refer to API Roles and Visibility.

   

2. Select the compliance standard for this product.

   API Cloud is committed to provide the trust required to provide API integration for clients. APIs published in API Cloud must be compliant to at least one of the standards provided in this section.

3. Select Continue to publish, or select Back to return to the previous section.

Publish your product

To publish your product:

1. In the Publish section, toggle the Publish this product to Pre-Prod Environment to the ON position (defaults to off).

   

2. Select Complete to publish and continue with Enforcing Approval Workflows, or select Back to return to the previous section.

Configure your product subscription approval workflow

To configure your product subscription approval workflow:

After you publish your product, you can also enforce a subscription approval workflow.

1. Select the Request Approval options.

   • Select Closed to enforce approval workflow. Consumers must complete the subscription workflow and submit the request to use your product.
   • Select Open to allow anyone in Trimble to subscribe to your API product.

   

2. Select ADD DOCUMENT to upload the API Specification

3. Select COMPLETE to save changes.

4. Continue with Consuming an API.