Manage APIs in an API Collection Task

To add a new API Collection task with a new API:

1. Click the program name or create a new program on the Programs In Design page.
2. Under the Program Setup tab, click Add Task, and then select API Collection from the drop-down menu.
3. On the Manage Tasks page, in the section Details, provide the following:
   • Name (Required)
   • Description (Optional)
   • To Be Executed By (Required): Partners, Any Internal User or Select Internal Users
   • Internal Reviewer (Required): None, Any Program Owner, Any Internal User or Select Internal Users

   Note You have an option to make this task mandatory.

4. In the section Content Configuration, click Add API to configure your APIs to be executed to streamline and automate partner onboarding.
5. Provide the following:
   • Name (Required)
   • Description (Optional)
   • Request Method (Required): GET, POST or PUT
   • Request URL (Required)
   • Params
   • Authorization: No Auth, Basic Auth (requires a username and a password passed along with the request) or Bearer Token (requires an authorization token passed along with the request)
   • Headers
   • Body
   • Post Execution: Expected Response (comma separated response codes (eg. 200, 201, 405); this filed is REQUIRED), Delay (add a sufficient delay to execute this API so that the next API can avail its results), Environment Variables (once the values of the variables are set, they become available to all the APIs within the same task at the execution level; the key and the value will be shared with other APIs within the task after an API is successfully executed and the values are available).

     Note The post execution environment variables also become available to the rest of the task in the program once the API task is marked Сomplete.

6. Click Add.

   Note You can add multiple APIs to the same API Collection task. Use the arrow buttons () next to the APIs to manage the order in which they must be executed.

7. In the section Post Execution, provide messages that will be displayed once the task is fully executed and environment variables.

   Note If all the configured APIs in the API Collection task are executed successfully, you, as a partner user, can submit or complete the task automatically on condition that the task does not require review.

8. Click Save or Save and Close.

To edit an API from an API Collection task:

1. Click the program name on the Programs In Design page.

   -Or-

   On the Active Programs tab of the Programs page, click the program name you require.

2. Under the Program Setup tab, in the section Tasks, click Manage Tasks.
3. From the list of found tasks, click the API Collection task containing the API you want to edit.
4. In the section Content Configuration, from the list of available APIs, click Edit () for the API you need.
5. Update the API configuration and then click Save.

To delete an API from an API Collection task:

1. Click the program name on the Programs In Design page.
2. Under the Program Setup tab, in the section Tasks, click Manage Tasks.
3. From the list of found tasks, click the API Collection task containing the API you want to delete.
4. In the section Content Configuration, from the list of available APIs, click Delete () for the API you need.
5. Confirm the operation and then click Save.

Note You can also delete the whole API Collection task by clicking Delete on the right side of the API Collection configuration page.

To download an API execution log from an API Collection task:

1. Click the program name on the Active Programs tab of the Programs page.
2. Go to the Tasks tab.
3. In the Partner Execution Summary section, in the task details, next to the status of the API, under Logs, click to download the execution log file.

Note Logs become available after the API task has been executed by any user (even by a partner) and only when the API task status is Success, Failed, or In Progress.

You can view/review the execution details in the API collections task.

To view/review the execution details:

1. Click the program name on the Active Programs tab of the Programs page.
2. On the Tasks tab, select an API collection task the details of which you want to view or review.
3. In the Partner Execution Summary section, view or review the following task details:
   • The task name
   • The task current status
   • Enrolled partners for a certain task
   • Logs
   • Description
   • Execution time
   • The executioner name

You can import API configurations (the Content Configuration) as files in the JSON format to view and use all the imported APIs and their post execution variables.

Note You can import API configurations till a certain program is published. Once the program is published, you can import only newly added API tasks to the program.

You can export an API configuration (the Content Configuration) with the post-task execution variables configured for each API as a file in the JSON format from an API collection task.