Registering Your First APIs with digiRunner

Register external APIs to digiRunner, and after they are enabled, the APIs can be called through digiRunner.

Registering APIs

The system can register the APIs saved on the AP Server into the system, and then have the system manage the APIs.

1. Go to API Management > API Registration, and click CUSTOMIZE to enter the registration page.

2. Fill in the required fields: Target URL, API Name, digiRunner Proxy Path and Http Methods.

3. Since authentication is not required for now, select No Auth.

4. Click Register to complete the registration of that API.

1. Go to API Management > API List to query the API just registered, the default status of the API is disabled ().

For more information on creating an API proxy, please refer to API Registry.

Enabling/Disabling APIs

Enable/Disable can be used to restrict the calling of APIs registered into system management.

1. Go to API Management > API List to query APIs that have been registered successfully.

1. Click on the icon to open the testing area, and select No Auth for Authorization.

2. Click Test to view the response. In this example, the Status code returned is 503, and the Body contains the data "API was disabled".

1. Return to the list and select the API; the default status at this time is disabled (). Select the API, and click Enable.

2. A confirmation window for enabling will pop up, click Confirm, and the API status will be updated to enabled ().

1. Click on the icon to open the testing area, and select No Auth for Authorization.

2. Click Test to view the response. In this example, the Status code returned is 200, indicating a successful call, and the Body contains the data defined by that API.

Testing APIs

APIs registered into system management can be called from the API test area. NO Auth is used as the example below.

1. Go to API Management > API List, and query APIs that have been registered successfully into API, then click on the icon to open the testing area.

1. Select No Auth for Authorization. The target URL will be retrieved automatically for the digiRunner URL field, and the default Http Method is GET.

2. Click Test to view the response. In this example, the Status code returned is 200, and the Body contains the data defined by that API.

1. Go to API Management > API Test, and fill in the digiRunner URL field with the target URL.

2. Select No Auth for Authorization.

3. Click Test to view the response. In this example, the Status code returned is 200, and the Body contains the data defined by that API.

Next, you can try our most common use cases.