Authentication - accountsIQ/API-Wiki GitHub Wiki
Our SOAP API supports two versions of authentication: Make sure that your API endpoint matched the version of authentication you are using
- Version 2.0 – This is the current standard and should be used for all new integrations.
- Version 1.1 – This version is only supported for existing integrations and will not be used for new integrations. Documentation still available, see below
Note
Version 1.1 is only supported for existing integrations. It will no longer be used for any newly created integrations. To set up new integrations, please refer to the documentation for Version 2.0
Creating an Integrations Application and Inviting a Developer to the Developer Portal
To get authenticated you will need a Client Id and Client Secret
Integration_2_0 ws = new Integration_2_0();
var token = ws.TokenGet(<clientId>, <clientSecret>);
if (tokenGetResponse != null && tokenGetResponse.Result != null)
{
this.AccessToken = tokenGetResponse.Result.AccessToken;
this.RefreshToken = tokenGetResponse.Result.RefreshToken;
}
else
{
throw new Exception("TokenGet Failed! Could not get an Access Token");
}
Before you can call a method, you need to set the Token and the Entity ID in the header.
// Set the header to take the token and the entity ID
ws.AiqSoapHeaderValue = new AiqSoapHeader { AccessToken = this.AccessToken, Entity = this.CompanyID };
// Note each method in Version 2.0 has a token as its first parameter. This is here for compatibility and should be left blank, as the token is already set in the header
var result = ws.GetCurrencies(string.Empty);
When you token expires, you will need to refresh it by calling TokenRefresh
...
ws.TokenRefresh(clientId, clientSecret, this.RefreshToken);
if (tokenRefreshResponse != null && tokenRefreshResponse.Result != null)
{
this.AccessToken = tokenRefreshResponse.Result.AccessToken;
this.RefreshToken = tokenRefreshResponse.Result.RefreshToken;
}
else
{
throw new Exception("TokenRefresh Failed!");
}
Learn how to create an Integration Application and invite a developer to the Developer Portal
Learn how to use the Developer Portal and the new API Authentication Endpoints
To get authenticated simple call the Login method. You will need the CompanyIDny Id, a Partner Id and User Key
Integration_1_1.Integration_1_1 ws = new Integration_1_1.Integration_1_1();
String auth = ws.Login(companyID, partnerKey, userKey);
if (auth != null)
{
// ...
}
You simple call the same Login Method as above.