🔒API Authentication

API Authentication

To authenticate your API requests, you need to include a header called x-helium-api-key in every API call.

Header Format

 x-helium-api-key: your_api_key_here

Example

Below is an example of how to include the x-helium-api-key header in a request using different tools and languages.

cURL

curl -X GET {api_base_url}/api/v1/tags/{id}" -H "x-helium-api-key: your_api_key_here"

JavaScript (Fetch API)

fetch(api_base_url+'/api/v1/tags/{id}', {
  method: 'GET',
  headers: {
    'x-helium-api-key': 'your_api_key_here'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

Python (Requests)

import requests

url = api_base_url+"/api/v1/tags/{id}"
headers = {
    'x-helium-api-key': 'your_api_key_here'
}

response = requests.get(url, headers=headers)
print(response.json())

Adding the Header in Postman

1. Open Postman and select your request.

2. Go to the "Headers" tab.

3. Add a new header with the key x-helium-api-key and set the value to your_api_key_here.

By including the x-helium-api-key header in every request, you ensure that your API calls are authenticated and authorized to access the resources.