API Keys¶
Wherobots API Keys allow you to authenticate with Wherobots Cloud for programmatic access to Wherobots APIs and services. They can be created by any Wherobots user and ensure that requests are executed as though they were made by the user themselves.
This enables usage of Wherobots APIs like the Spatial SQL API in scripts, CI/CD pipelines, or with Apache Airflow ETLs and other automated workflows.
Usage¶
To use an API key, you must include it in the X-API-KEY header of your HTTP requests.
Example¶
curl -H "X-API-KEY: your_api_key_here" https://api.cloud.wherobots.com/users/me
Create an API Key¶
-
Begin by navigating to your user settings.
-
Once in your user settings, locate and select the button labelled "Create" next to the heading "API Keys".
-
Provide a name for your new API key. Choose a name that is descriptive and meaningful, to help you remember its purpose in the future.
-
Choose an expiration date for your API key.
-
Click on the "Create" button. This action will generate your new API key.
-
Copy the API key. We do not allow you to view the API key again.
-
Confirm the completion of the process by clicking on the "Close" button.
Warning
Store your newly created API key in a secure location. This could be a password manager or another secure digital environment. Remember, your API key is sensitive information and should be treated with the same level of security as your password.
Revoke an API Key¶
-
Begin by navigating to your user settings.
-
Once in your user settings, locate the API key you wish to revoke.
-
Click on the triple-dot icon to right right of the entry, then click "Revoke".
