How to Manage an API

How to search for an existing API

Once you have navigated to the API Library module, a search bar will be displayed at the top of the API list. This search bar will actively filter APIs as you type to include only APIs matching the input in one of the following ID categories: Group Name, API Name, Description, API Tags, or Version.

How to view API details

To view details of a specific API, locate the API within the API Library list or by using with the search bar. Select the blue eye icon under the actions column. This will bring up a list of available consumers that can be authorized to use the API. You can change the authorization for each individual consumer. 

Selecting the blue eye icon again, next to a specific consumer, will display the details of the API. Alternatively, click the “Try it Out” option to view sample outputs, code snippets or to execute the API.

Note: Authorization of an API must be set to on before the “Try it Out” link is enabled.

How to edit an existing API

To edit a specific API, locate the API within the API Library list or by using the search bar. Then select the green pencil icon under the actions column. This will bring up a list of available consumers that can be authorized to use the API. You can change the authorization for each individual consumer. 

From here, you can click the pencil icon next to a specific consumer. This will take youto the details of the API where you can alter the API information as shown in the API creation documentation.  

You can also use the disable/enable icon to toggle the status of the API for a specific consumer.

How to Disable/Enable an API

To disable or enable a specific API, locate the API within the API Library list or by using the search bar. Select the disable or enable button that appears in the action column. A pop-up will appear to confirm your choice. Once confirmed, the system will switch the specified API between disabled and enabled. 

Additionally, you can disable the API for specific consumers by selecting the green pencil icon to go to the API’s consumer page and then select the disable/enable button for your chosen consumer.

How to Delete an API

To delete a specific API, locate the API within the API Library list or by using the search bar. Select the red trash can icon that appears in the action column. A pop-up will appear to confirm you wish to delete the API. Once confirmed, the system will delete the API from Illuminate 

Deleting an API will only delete the specific API version selected. 

How to Copy an API

To copy a specific API, locate the API within the API Library list or by using the search bar. Select the green copy icon that appears in the action column. Illuminate when then move you to the copy interface. Here, you can copy the API as is, or make edits to the copy before you save the new API. If you are copying the API as is, simply click save at the bottom of the interface to create the copy. Otherwise, select 'Modify Selection' before making your chosen modifications to the API. Once done, simply click save to create your new API.