Authentication

The Vome API uses an API key for authenticating requests, exclusively available to users who have subscribed to the Ultimate plan (learn more about our plans here). Using an API key helps ensure that sensitive data remains secure and accessible only to authorized users. Generating an API key 1. Login to your administrative account on Vome 2. Using the left-hand navigation, click Integrations & Apps 3. Click the option API & webhooks to bring you to the developer dashboard 4. Click Generate secret key 5. Add a title to easily identify the use of this API key and click Generate key 6. Copy the secret key and keep it somewhere safe! You will not be able to view this secret key once you close the popup. You will need this secret key to integrate Vome's endpoints with 3rd party software, as it is what is used to authenticate the requests.

Using the API key

With the API key, you can authenticate your requests by including it in the headers (as shown below):

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/data", headers=headers)

Security practices

• Keep Your Key Secure: Your API key enables access to Vome data, so never share your API keys in publicly accessible areas such as GitHub, client-side code, etc.

• Use HTTPS: All API requests must be made over HTTPS. Calls made over plain HTTP will fail, and API requests without proper authentication will also be rejected.

---