Perform your first API call
The goal of this page is to give examples on how to perform an API call in your application.
Last updated
The goal of this page is to give examples on how to perform an API call in your application.
Last updated
Anchor link to the article.
Perform a GET request to the API endpoint of choice with '/openapi' amended to retrieve the OpenAPI specification for the given API. Example:
GET
https://api.altum.ai/avm/openapi
Press "send" to perform the request.
Add the endpoint URL of the API behind the POST/GET function into the endpoint URL box. Then add the JSON message to the JSON entry field. Lastly, configure the headers to include the Content-Type and the x-api-key for authentication and press "Send".
Add the x-api-key header and API key for authentication. Set the Body to raw and JSON when performing a POST request. Press "Send"
Go to and add the endpoint URL in the URL-box. Depending on the API, select a POST or GET request. Be sure to select "DE" or "EXT" as the server for faster processed requests. Add the message / request in the Content tab. Add the x-api-key header for authentication to the Headers tab.
Download and install the free program . Create a new 'Request collection'. Add a 'New Request' (CTRL + N) and gives this request a name. Select POST or GET depending on the API and use JSON for the Body Text when Posting.
Download the app. Create a new HTTP Request. Select the method GET or POST depending on the API and add the endpoint URL. Set authorization to No Auth.