Connecting to ChargeOver
ChargeOver uses token authentication to control access to the API.
Using Token Authentication
In order to authenticate to ChargeOver, you'll need to provide your APIKey and APISecret. To obtain your credentials (APIKey and APISecret), log in to ChargeOver, and click the settings gear/cog in the top right > Choose "Developer" from the left-side navigation menu > Choose "REST API" > Enable the API, and copy your API credentials: Public Key/Username is your APIKey and Private Key/Password is your APISecret. Additionally, you will need to set the Domain, found in the domain name of your ChargeOver account. For example if your ChargeOver portal is acmeinc.ChargeOver.com, then the Domain should be 'acmeinc'. Set the APIKey, APISecret and Domain in the ProfileSettings property to connect.
Example connection string
Profile=C:\profiles\ChargeOver.apip;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your_domain';
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.
Property | Description |
APIKey | Your CHARGEOVER Public API Key. |
APISecret | Your CHARGEOVER Private API Key/Password. |
Domain | The domain for the CHARGEOVER account. |