TotalFlow Optimizer APIs

To use the APIs, your application must authenticate with either a user name and password or an API key.

If you use a user name and password, the application must use the POST /auth web service first to generate a token, then include that token in any additional requests.

If you use an API key, you generate the key in TotalFlow Optimizer and include it in the request. You must manage your keys according to your security policies.

You can do these actions on the API keys:

Create

Generate an API key and give it a name. The key is automatically generated when you create it. Copy the value of the key to use in other applications.

Copy

Copy the key generated by TotalFlow Optimizer to use with an external application.

Enable

Enable a key to connect your application with TotalFlow Optimizer.

Disable

Disable a key temporarily or permanently to prevent other applications from accessing TotalFlow Optimizer.

Note:
• Disabling a key does not delete it.

Renew

Renew an existing API key by replacing the current API key with a new key. The current API key is scheduled for deletion but it remains valid for the next 24 hours and you can use during that time.

Delete

Delete a key permanently. Once you delete a key, the key cannot be used to make API requests.