Connecting to Collaboflow

The Collaboflow API uses a APIKey or Password based authentication.

Using APIKey Authentication

Your Collaboflow API Key is required to create a connection to Collaboflow. Generate the API Key at Collaboflow admin settings page, then set it in the ProfileSettings connection property. You should specify the Instance and AppCd properties in the connection string as well.

Example Connection string

Profile=C:\profiles\collaboflow.apip;User=my_user;ProfileSettings='Instance=my_instance;AppCd=my_appcd;APIKey=my_api_key;'

Using Password Authentication

Alternatively, you can authenticate using password authentication. To do so, specify the Username, Password, Instance name, and AppCd in the connection string.

Example Connection string

Profile=C:\profiles\collaboflow.apip;User=my_user;Password=my_password;ProfileSettings='Instance=my_instance;AppCd=my_appcd;'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.