API Management FAQ - TPIsoftware Documentation

FAQ

1. Platform Permission

We have different API development & admin departments. Can I seperate the permission levels?

digiRunner features platform organization. You can easily set up the platform hierarchy based on your needs. Besides, you can also set up role permission to manage platform permission on each level.

2. API Proxy

How do I manage my APIs stored in different AP Servers?

digiRunner provides API Proxy Service. You can register your APIs to digiRunner via API url (http / https). Or you can register your APIs via Swagger document to digiRunner and delegate digiRunner to handle the proxy and management.

3. API Encryption

Can I encrypt my APIs without additional coding effort on backend?

Yes, you can add the JWE/JWS to your APIs via digiRunner Admin Console. Besides, the API list allows you to check if the APIs have JWE/JWS encryption or not.

4. API Switch (On/Off)

Can I disable my API for security concerns or the API no longer needed?

It’s easy. You can enable or disable APIs via digiRunner Admin Console.

5. API Group and Client Management

My APIs have different security levels; can I group the APIs of the same type?

Yes, digiRunner provides an API grouping feature. You can put APIs of same type or same security level into a group. Besides, You can authorize the API group to your API clients at once instead of one by one.

6. Format Transformation

My APIs have different formats such as XML. Can I import APIs to digiRunner and make digiRunner take over the proxy thing? Besides, Can I convert the API format such as XML to JSON?

Yes. The digiRunner API Composer provides diverse function nodes that allows you to create an API to connect to your backend systems, such as MQ and SAF RFC.
With digiRunner API Composer, you can easily drag and drop the function node to create an API.

7. Backend System Connection

I want to connect to my backend systems, but it takes time and coding effort to develop APIs. Can digiRunner help?

Yes. The digiRunner API Composer provides diverse function nodes that allows you to connect an API to to your backend systems, such as MQ and SAF RFC. With digiRunner API Composer, you can easily drag and drop the function node to create an API.

8. API Authorization

My APIs have different authorization flows. Can digiRunner help me with the settings?

Yes. digiRunner provides the following API authorization methods:
- Public
- API key
- Oauth2.0 ( Client Credential / Password / Auth Code / Implicit ) Besides, the settings can be easily done through digiRunner Admin Console.

9. API Test

How can I make sure that API proxy is working normally?

You can test the API Proxy with digiRunner Admin Console. Besides, you can validate the API url via digiRunner Admin Console as well.

10. API Statistic Report

How do I know which APIs are the most popular and which client calls the API the most times?

digiRunner features an API statistic report. You can see the API usage trend chart or API log via digiRunner Admin Console. Besides, you can export the report into a CSV file.

11. API Log

There is something wrong with one of API transactions; can I check the API log?

Yes, You can check the API log detail through digiRunner Admin Console.

12. API Proxy Security

Is it safe to let digiRunenr take over the API Proxy?

Yes. digiRunner provides WAF protection, traffic control and IP bond.

13. API Portal & API Publication

How can I share my API with internal & external partners?

You can publish your APIs to API Portal and set up the publication status ( internal / external) so your partners (API Clients) can search the APIs they need and request authorization.

14. API Portal Management

Can I manage the API portal?

Yes, you can manage the following features of API Portal through the admin console.
- API Theme
- FAQ
- About us
- SiteMap
- Announcement
- Swagger Settings

FAQ