Developers

Appearance

API Authentication ​

API Key ​

We strongly recommend that you create your own API key via VORTEX portal and use it for authentication when accessing the API. This method provides more secure and reliable access.

To create an API key, please refer to the How to Manage API Keys?.

After Getting Your API Key ​

Once you have obtained your API key, please ensure to keep it safe and secure. You can use this API key to access other APIs listed in the API documentation.

For example, after getting the API key, you can access the organization info with the following request:

sh
  curl --request GET \
  --url https://api.dev.vortexcloud.com/v1/organizations \ # Switch to stage/production API server url per your environment
  --header 'Authorization: Bearer API_KEY'

[Deprecated] Access Token ​

You may also refer to the deprecated method of using an access_token for authentication. However, please note that this method is no longer recommended and may be removed in future updates.

For more information on how to use the access_token authentication, please refer to the manual.