Access Versa Concerto REST APIs Using Swagger UI
For supported software information, click here.
Versa Concerto is integrated with Swagger, which provides a webpage to display the Concerto REST APIs. You can use Swagger UI to run real-time REST API commands and to export the APIs as YAML or JSON files that you can use to generate client code.
Concerto provides REST APIs so that you can integrate upstream (northbound) applications. A number of integration options allow you to customize the integration of applications.
This article describes how to access the Swagger webpage, navigate to different APIs by section, export and download APIs, and generate client code for the API file.
Note that to access the Swagger webpage, you need the management IP address or domain name of the Concerto device on which you want to execute the REST APIs. No additional permissions are required to run the REST API client.
Access the Swagger Webpage
- Log in to the Concerto portal. Note that in Chrome, when you are on the NET::ERR_CERT_INVALID tab, you may have to accept a certificate or accept the "This is unsafe" option to proceed.
- Click the user menu in the top menu bar, and then select API documentation. The API documentation popup window displays.
- Select Core Service or Monitoring Service.
- The Swagger webpage for the Concerto REST APIs displays.
- To grant different levels of access to API data for different users, click Authorize. The Available Authorizations window displays, and you can set authorization scopes.
- Enter the login credentials to log in to Concerto.
- Click Authorize to save the changes.
Navigate to the Concerto REST APIs
- On the Swagger webpage, select an API call in the Select a Spec field in the top menu bar.
The details of the selected API call display in the main window. The following screen displays the Predefined App Group Logo Controller API group.
- To change the values of an API call, click Try It Out and then update the required fields.
- Click Execute.
Export JSON Files for Concerto APIs
To export JSON files for Concerto APIs, on the Swagger webpage, click the highlighted URL to generate YAML for all the APIs.
API documentation displays in JSON format. For example:
Generate Client Code
To generate client code for the downloaded API file (JSON or YAML):
- Navigate to https://editor.swagger.io/. The SwaggerEditor webpage displays.
- Click File > Import file, and then select the API file you saved in Export APIs To Generate Client Code, above.
- Click Generate Client, and select a client and the language of the code to generate.
- Save the file at the desired location.
Supported Software Information
Releases 11.1.1 and later support all content described in this article.