FPT API Management

After the provider publishes a product on a site, the client cannot immediately use those APIs. To enable client access, the provider must go to the Consumer menu to create client information and assign the client to a previously published product. Only then can the client utilize the APIs.

1. Creating New Consumers

Step 1: In the API Manager menu, select Consumers > Create.

Step 2: Enter the required information:

• Name: Consumer name.

• Site: Select an active Consumer site.

• API Key: Allow authenticate with an API key when enabled.

• Title: Title for the consumer.

• Password: Password if using Basic Authentication.

• Confirm Password: Password confirmation.

• Max per second: Limits the number of API calls the client can make per second.

• Max per minute: Limits the number of API calls the client can make per minute.

• Max per hour: Limits the number of API calls the client can make per hour.

Step 3: Click OK to create.

2. Subscribe to a Product

Once the Consumer is created, to use the APIs within a Product, the Consumer must subscribe to the Product.

Step 1: In Consumer Management, select the Consumer and click Product Subscription.

Step 2: Click Subscribe Product.

Step 3: Select the Product. The Product must be in a published state to select it in the subscription interface.

Step 4: Click OK.

The client can now use the APIs provided by the API Provider.

Note: The product must be in a published state for the consumer to subscribe.

3. Unsubscribing Product

Step 1: In Consumer Management, select the Consumer and click Product Subscription.

Step 2: Click Unsubscribe Product.

Step 3: Click OK.

4. Modifying Consumer Information

To adjust a Consumer's information, follow these steps:

Step 1: In Consumer Management, select the consumer to modify > Edit.

Step 2: Enter the new information and click OK.

Note: Some fields cannot be changed and will be disabled in the edit interface.

5. Retrieving Consumer Authentication Information

To use APIs created from API Management, the Consumer must retrieve authentication information and provide it when sending requests to APIs. Currently, API Management supports two authentication methods: Basic Auth (User/Pass) and API Key.

5.1. Retrieving Username and Password for Basic Auth:

• Username: Username follows this structure: Username = UsernameProvider + site name + usernameConsumer.

  For example: demo123.sitedemo.demoacc

  Or as provided in the Consumer's authentication information:

  In Consumer Management, select the Consumer > Edit.

  

• Password: Password of the user declared during Consumer creation.

5.2. Retrieving API Key Information:

Step 1: In Consumer Management, select the Consumer > Edit.

Step 2: Retrieve the API Key from the API Key field.

6. Deleting a Consumer

To delete a previously declared Consumer from the system, ensure the Consumer has unsubscribed from all Products. To unsubscribe from products, follow the íntruction in the Unsubscribing Product section.

To delete a Consumer, follow these steps:

Step 1: In Consumer Management, choose the Consumer to delete > Remove.

Step 2: In the confirmation popup, click Yes to proceed.

Note: If you encounter this error: Could not remove that consumer as there are still subscriptions of that consumer!, you need to unsubscribe from all products before performing this action.