Introduction

Authentication is required to make a successful API request. The Vena API authenticates using the HTTP Basic Auth. All API requests must be made over a secured connection using HTTPS.

Generating an application token

On Vena's web application, you can obtain the username and password needed for HTTP Basic Auth by navigating to vena.io, selecting the Admin tab, and navigating to the tab labelled Application Tokens.

Accessing Application Tokens in Vena Admin Tab

🚧
Note
If you do not have access to the Admin tab, please ask an Admin in your company for the credentials.

Adding Application Token Permissions

Once you create an Application Token, assign the appropriate Application Permissions in the Token Permissions section.

Admin tab showing application token details

Application Token Credentials

You can now retrieve your token credentials to use for authentication and making API requests.

Authenticating a Vena API request

Vena uses basic authentication to secure API requests. The username and password values are as follows:

Username is your apiUser from above, and
Password is your apiKey from above

Option 1 — cURL

If using cURL or a similar request language, include the username and password by adding -u {username}:{password} to your request.

curl https://us2.vena.io/api/public/v1/etl/templates -u 1112140681100620800.1:51fd255f934040888f98d2a74d1c4391

Option 2 — Postman

If using an API tool such as Postman, select Basic Auth and use your apiUser and apiKey as the credentials.

Configuring Basic Authentication in Postman

Option 3 — Python

If writing a script in Python, you can find examples in recipes:

Export all intersections (Beta)