Chapter 3. Making API calls

Procedure

1. Open the API catalog in a web browser. The API catalog lists available APIs for Insights and other services.
2. Select Advisor from the catalog. The Insights Advisor API page opens. The page lists the base URL of the Advisor API and any requirements for authentication.

3. Under the Operations list, click the drop-down arrow next to GET /api/insights/v1/account.

   The description for the operation includes parameters you can use to refine your API call, and also expected responses from the server. In addition, the panel on the right side of the page has sample code to perform the API call in many languages.

4. In the panel, click the drop-down and select CURL from the list of options. The panel displays sample code for the GET operation, formatted as a curl command.

5. Copy the sample code and paste it into your command line or into an existing code file where you want to invoke the GET command.

   # curl --request GET \
   --url https://console.redhat.com/api/insights/v1/account/ \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json'

   Copy to Clipboard Toggle word wrap
6. Paste your access token in place of <token>.
7. Press Enter to invoke the command.

Procedure

1. Open the API catalog in a web browser. The API catalog lists available APIs for Insights and other services.
2. Select Advisor from the catalog. The Insights Advisor API page opens. The page lists the base URL of the Advisor API and any requirements for authentication.
3. Under the Operations list, click the drop-down arrow next to GET /api/insights/v1/account. The description for the operation includes parameters you can use to refine your API call, as well as expected responses from the server. In addition, the panel on the right side of the page generates an example API call for the GET operation in multiple programming languages.
4. In the panel, click the drop-down and select the programming language that you prefer (for example, Python) from the list of options. The panel displays sample code for the GET operation, formatted in Python syntax.

5. Copy the sample code and paste it into a Python code file where you want to invoke the GET command. For example:

   import requests
   
   url = "https://console.redhat.com/api/insights/v1/account/"
   
   headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
   }
   
   response = requests.get(url, headers=headers)
   
   print(response.json())

   Copy to Clipboard Toggle word wrap
6. Paste your authorization key for authentication in place of <token>.
7. Press Enter to run your code.

Procedure

1. Navigate to the API documentation page in the Red Hat Hybrid Cloud Console.
2. Select the application that you want to use from the list (for example, Advisor). The page for the application displays, with a list of all the operations you can request for that application.
3. Select the operation that you want to perform (for example, Advisor > account > GET /api/insights/v1/account).
4. Click the drop-down arrow for the operation. The Swagger documentation page describes the operation and lists the parameters you can use to refine your request. The page also shows the JSON format for a successful server response.
5. Click Try It Out. The page displays the format of a successful server response. If the operation you selected requires a value for a parameter (for example, org_id), enter the value in the blank.

6. Click Execute. The page displays a curl request to the server, the request URL, and the server response.

   1. To copy the curl request to the clipboard, click the clipboard icon on the right side of the curl request.
   2. To copy the server response to the clipboard, click the clipboard icon in the top right corner.
   3. To download the server response as a JSON file, click Download.
7. Optional: To clear the server response and retry the command, click Clear.