Skip to content

v4.0.0: Integration API V2

Compare
Choose a tag to compare
@altJake altJake released this 31 Mar 14:36
· 40 commits to master since this release
bac5412

⚠️ Breaking Change: Please notice the new distinction between integration_auth and api_key_v1 authentication strategies

From version 4.0.0 onwards, the integration_auth strategy will be use for legacy HMAC authentication only (in deprecation process).
For the correct usage of this strategy, please consult this piece of code in the README file.

If until today you used the integration_auth while initiating your ApiClient instance and set the api-key and prefix as advised before:

ApiClient iApiClient = new ApiClient("integration_auth");
IntegrationApi iApi = new IntegrationApi(iApiClient );
        
// Setup: basePath, apiKeyPrefix and apiKey
iApi.getApiClient().setBasePath("https://mycompany.talon.one");
iApi.getApiClient().setApiKeyPrefix("ApiKey-v1");
iApi.getApiClient().setApiKey("dbc644d33aa74d582bd9479c59e16f970fe13bf34a208c39d6c7fa7586968468");

// ...

Please notice that you will have to pass the api_key_v1 strategy from now on, the rest of the code could be used as before:

- ApiClient iApiClient = new ApiClient("integration_auth");
+ ApiClient iApiClient = new ApiClient("api_key_v1"); 

// ... no change