Setting up an API call
The goal of this page is to give examples on how to set up an API call in your application.
Anchor link to the article.
Go to Reqbin.com 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.
Press "send" to perform the request.
Curl/Bash
#!/bin/bash
curl -X POST https://api.altum.ai/sandbox/avm -H "x-api-key: m2ipzWVV3e9yPU9TduqpY4oZTbcEHCGj31GLVLYB" -H "Content-Type: application/json" --data-binary @- <<DATA
{
"postcode" : "1234AB",
"housenumber" : "1"
}
DATA
Download and install the free program Insomnia. 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.
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".
Message
curl --request POST \
--url https://api.altum.ai/sustainability \
--header 'Content-Type: application/json' \
--header 'x-api-key: m2ipzWVV3e9yPU9TduqpY4oZTbcEHCGj31GLVLYB' \
--data '{
"data": {
"lock_measures": {
"lock": [
"wall_insulation"
]
},
"max_investment": 20000,
"gas_usage": 3000,
"post_code": "2771DS",
"house_number": "87",
"target_label": "A",
"inner_surface_area": 130,
"inhabitants": 3,
"replace_boiler": true,
"heat_pump_allowed": true,
"search_criteria": 1,
"search_options": 2,
"house-type": 1,
"natural_gas": 0,
"solar_panels_surface": 1,
"watt_panels": true,
"wall_insulation": 1,
"roof_insulation": 1,
"floor_insulation": 1,
"living_room_windows": 1,
"bedroom_windows": 1,
"installation": 4,
"shower": 0,
"ventilation": 0,
"solar_panels": 10
}
}'
Download the Postman 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.
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"
Request
Headers
Body
Last modified 1mo ago