Here's a procedure to explain to API consumers how to connect to product APIs. From the Developer portal:
- Select the Product API: from the catalog, choose the API product you are interested in.
- Versioning APIs: you will find the available API versions in the left-hand menu. Select the API version you are interested in. Please note that it may be stated that the version is deprecated, so please select the most recent version.
- Download OpenAPI documentation: download the OpenAPI documentation (Swagger) for the selected API product using the "View Raw" button (top right). This will enable you to automate the generation of your API access points.
- Use the code generator: if you're running on Java, you can use Maven to generate your POJO (Plain Old Java Object) code, based on the OpenAPI contract. Use the REST template to choose your API. Equivalent generators exist for other languages, e.g. openapi-generator.
- Available endpoints: consult the list of servers and associated endpoints by clicking on the list below "Servers".
- Test connection: perform a quick test to verify that you can access the APIs and retrieve the necessary data, directly from the portal using the "Try it" panel on the API's own page, or with a tool such as Insomnia or Postman.
If you encounter any problems with the API, please contact the API team for assistance.
- Please make sure your application has been granted access to the API you want to use. Without an API key, you may receive an error message when testing.
- Request an API key through the Azure application registration form in SNOW.
- Do not hesitate to contact the API owner in case of any doubts regarding the authentication procedure associated with an API.
Available directly on every API's reference page in this portal - send real test requests with your own credentials, no separate tool required.