The API Explorer is the main screen that appears once the application is accessed and it is the one that belongs to the home icon.
In this screen you can see a list of all the APIs that have been imported into the organization where you are, regardless of the collection to which they belong.
In the list you can use the search engine and filters to search more easily for one of the APIs.
In addition, in each of the APIs there are icons with which you can access the API details, update the api or delete it.
API import #
In order to import an api you must click on the Import API button at the top right.
Once the button is clicked, a form should open with the following fields:
- Name of the API to import
- Collection where to save the API: If one is not selected it will take the one we have defined by default).
- Tags : You can create your tags by entering a name and then clicking on Create.
Import method which can be:
- Through a local file where a button will appear to select a file. (.json, .yaml, .iml, .yml)
- URL where a field must be filled in with the desired url (in raw format, it must be a public URL).
- Through gitlab, github, bitbucker or azure repository. The repositories will only be available if we have linked an account from “Settings”.
- Using corporate style guide. It will only be available if an api template has been previously imported.
- By standard definition where you can choose between Open telco and Open Banking and within this you must choose between Open Data API – ATM Locator, Read/Write API – Account and Transaction or Open Data API – Branch Locator.
Once the data has been entered by clicking on the Import Api button, the configuration is saved. If everything has been successful, a success message should be displayed. If an error occurs, an error message should be displayed clearly indicating the error.
API information #
In the “API Explorer” screen, each of the APIs in the table has an eye icon. By clicking on this icon you can access the API information.
Once this screen is accessed, two sections can be observed:
Firstly, “API First Cycle” appears where, as the name suggests, the API first cycle can be monitored. Secondly, there is the “General information” section.
In this section there is a drop-down menu to choose the branch where the development and main options appear.
