Removal of x-api-key Requirement for Public APIs
Overview
We are making an important update to AxelGlobe public APIs, specifically the STAC API and Tasking API. Effective immediately, the x-api-key header will no longer be required for accessing these APIs. This change is aimed at simplifying the authentication process for AxelGlobe clients while maintaining the same level of security and functionality.
Affected APIs
- STAC API: AxelGlobe's SpatioTemporal Asset Catalog (STAC) API.
- Tasking API: AxelGlobe's API for managing and scheduling tasks.
Changes
Previous Requirement
Previously, AxelGlobe clients were required to include the x-api-key header in their requests to authenticate and access the public APIs.
New Requirement
The x-api-key header is no longer required. Instead, the Authorization header will be the sole header required for authentication.
AxelGlobe Dashboard Changes
- The
x-api-keyfield will be removed from the dashboard. - The access token obtained using
client_idandclient_secretwill be included in theAuthorizationheader for API requests.
Example
Previous Request Example
curl -X GET https://api.axelglobe.com/stac/v1/catalogs \
-H "Authorization: Bearer your_access_token" \
-H "x-api-key: your_api_key"
Updated Request Example
curl -X GET https://api.axelglobe.com/stac/v1/catalogs \
-H "Authorization: Bearer your_access_token"
Reasons for the Change
-
Security Enhancement: By removing the
x-api-keyheader, we reduce the security risk associated with the potential exposure of API keys. -
Simplified Integration: AxelGlobe clients will now have more flexibility in their integration processes. With the removal of the
x-api-keyrequirement, the authentication mechanism is streamlined, making it easier to integrate with our APIs.
Impact on API Usage
- No Breaking Changes: This change will not break any existing API usage. Requests without the
x-api-keyheader will continue to function as expected. - Simplified Authentication: AxelGlobe clients only need to include the
Authorizationheader with their access token to authenticate and access the APIs.
Steps to Update Your Implementation
- Remove
x-api-keyHeader: Modify your API requests to exclude thex-api-keyheader. - Ensure
AuthorizationHeader: Verify that your requests include theAuthorizationheader with a valid Bearer token. g