API reference user guide

Authentication

To authenticate the endpoint in the API reference, follow these steps:

1. Navigate to the OpenAPI reference.

   

2. Select the Servers dropdown to choose the appropriate server for your API.

   Note

   Make sure your Hub account is in the same region as the endpoint server.

3. Locate Authorize button at the top of the reference page.

4. Click the Authorize button, and a dialog will appear.
5. In the dialog window, input the bearer token obtained earlier using tools like Curl or Postman.

6. Click the Authorize button within the dialog window to complete the authentication process. This step authorizes your API reference.

   

Now, you are free to test any endpoint securely.

---

Test an endpoint

1. Identify the specific endpoint you want to test within the OpenAPI reference.
2. Click on the endpoint to expand its details.
3. Explore the available parameters, request/response examples, and other relevant information provided in the console.

4. To test the endpoint, click the Try it out button.

   

5. Input any required parameters or payload data.

6. Click the Execute button to send a request to the selected endpoint.

   

7. Review the response details, including status codes and response payloads, to ensure the endpoint functions as expected.