Skip to content
Talon.One API SDK for Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
gradle/wrapper
src
.gitignore
README.md
build.gradle
build.sbt
git_push.sh
gradle.properties
gradlew
gradlew.bat
pom.xml
settings.gradle

README.md

talon-one-client

Talon.One API

  • API version: 1.0.0

The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the Integration API section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at https://mycompany.talon.one/docs/api/, the URL for the [updateCustomerProfile][] operation is https://mycompany.talon.one/v1/customer_profiles/id [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>one.talon</groupId>
  <artifactId>talon-one-client</artifactId>
  <version>3.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "one.talon:talon-one-client:3.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/talon-one-client-3.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import one.talon.*;
import one.talon.auth.*;
import one.talon.model.*;
import one.talon.api.IntegrationApi;

import java.io.File;
import java.util.*;

public class IntegrationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: integration_auth
        ApiKeyAuth integration_auth = (ApiKeyAuth) defaultClient.getAuthentication("integration_auth");
        integration_auth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //integration_auth.setApiKeyPrefix("Token");

        IntegrationApi apiInstance = new IntegrationApi();
        NewReferral newReferral = new NewReferral(); // NewReferral | 
        try {
            Referral result = apiInstance.createReferral(newReferral);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationApi#createReferral");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
IntegrationApi createReferral POST /v1/referrals Create a referral code for an advocate
IntegrationApi deleteCustomerData DELETE /v1/customer_data/{integrationId} Delete the personal data of a customer.
IntegrationApi trackEvent POST /v1/events Track an Event
IntegrationApi updateCustomerProfile PUT /v1/customer_profiles/{integrationId} Update a Customer Profile
IntegrationApi updateCustomerSession PUT /v1/customer_sessions/{customerSessionId} Update a Customer Session
ManagementApi addLoyaltyPoints PUT /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points Add points in a certain loyalty program for the specified customer
ManagementApi copyCampaignToApplications POST /v1/applications/{applicationId}/campaigns/{campaignId}/copy Copy the campaign into every specified application
ManagementApi createCampaign POST /v1/applications/{applicationId}/campaigns Create a Campaign
ManagementApi createCoupons POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Create Coupons
ManagementApi createPasswordRecoveryEmail POST /v1/password_recovery_emails Request a password reset
ManagementApi createRuleset POST /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets Create a Ruleset
ManagementApi createSession POST /v1/sessions Create a Session
ManagementApi deleteCampaign DELETE /v1/applications/{applicationId}/campaigns/{campaignId} Delete a Campaign
ManagementApi deleteCoupon DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} Delete one Coupon
ManagementApi deleteCoupons DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Delete Coupons
ManagementApi deleteReferral DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} Delete one Referral
ManagementApi deleteRuleset DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Delete a Ruleset
ManagementApi getAccessLogs GET /v1/applications/{applicationId}/access_logs Get access logs for application
ManagementApi getAccessLogsWithoutTotalCount GET /v1/applications/{applicationId}/access_logs/no_total Get access logs for application
ManagementApi getAccount GET /v1/accounts/{accountId} Get Account Details
ManagementApi getAccountAnalytics GET /v1/accounts/{accountId}/analytics Get Account Analytics
ManagementApi getAccountLimits GET /v1/accounts/{accountId}/limits Get Account Limits
ManagementApi getAllAccessLogs GET /v1/access_logs Get all access logs
ManagementApi getAllRoles GET /v1/roles Get all roles.
ManagementApi getApplication GET /v1/applications/{applicationId} Get Application
ManagementApi getApplicationApiHealth GET /v1/applications/{applicationId}/health_report Get report of health of application API
ManagementApi getApplicationCustomer GET /v1/applications/{applicationId}/customers/{customerId} Get Application Customer
ManagementApi getApplicationCustomers GET /v1/applications/{applicationId}/customers List Application Customers
ManagementApi getApplicationCustomersByAttributes POST /v1/application_customer_search Get a list of the customer profiles that match the given attributes
ManagementApi getApplicationEventTypes GET /v1/applications/{applicationId}/event_types List Applications Event Types
ManagementApi getApplicationEvents GET /v1/applications/{applicationId}/events List Applications Events
ManagementApi getApplicationEventsWithoutTotalCount GET /v1/applications/{applicationId}/events/no_total List Applications Events
ManagementApi getApplicationSession GET /v1/applications/{applicationId}/sessions/{sessionId} Get Application Session
ManagementApi getApplicationSessions GET /v1/applications/{applicationId}/sessions List Application Sessions
ManagementApi getApplications GET /v1/applications List Applications
ManagementApi getAttribute GET /v1/attributes/{attributeId} Get a custom attribute
ManagementApi getCampaign GET /v1/applications/{applicationId}/campaigns/{campaignId} Get a Campaign
ManagementApi getCampaignAnalytics GET /v1/applications/{applicationId}/campaigns/{campaignId}/analytics Get analytics of campaigns
ManagementApi getCampaignByAttributes POST /v1/applications/{applicationId}/campaigns_search Get a list of all campaigns that match the given attributes
ManagementApi getCampaignSet GET /v1/applications/{applicationId}/campaign_set List CampaignSet
ManagementApi getCampaigns GET /v1/applications/{applicationId}/campaigns List your Campaigns
ManagementApi getChanges GET /v1/changes Get audit log for an account
ManagementApi getCoupons GET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons List Coupons
ManagementApi getCouponsByAttributes POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search Get a list of the coupons that match the given attributes
ManagementApi getCouponsByAttributesApplicationWide POST /v1/applications/{applicationId}/coupons_search Get a list of the coupons that match the given attributes in all active campaigns of an application
ManagementApi getCouponsWithoutTotalCount GET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total List Coupons
ManagementApi getCustomerActivityReport GET /v1/applications/{applicationId}/customer_activity_reports/{customerId} Get Activity Report for Single Customer
ManagementApi getCustomerActivityReports GET /v1/applications/{applicationId}/customer_activity_reports Get Activity Reports for Application Customers
ManagementApi getCustomerActivityReportsWithoutTotalCount GET /v1/applications/{applicationId}/customer_activity_reports/no_total Get Activity Reports for Application Customers
ManagementApi getCustomerAnalytics GET /v1/applications/{applicationId}/customers/{customerId}/analytics Get Analytics Report for a Customer
ManagementApi getCustomerProfile GET /v1/customers/{customerId} Get Customer Profile
ManagementApi getCustomerProfiles GET /v1/customers/no_total List Customer Profiles
ManagementApi getCustomersByAttributes POST /v1/customer_search/no_total Get a list of the customer profiles that match the given attributes
ManagementApi getEventTypes GET /v1/event_types List Event Types
ManagementApi getExports GET /v1/exports Get Exports
ManagementApi getImports GET /v1/imports Get Imports
ManagementApi getLoyaltyPoints GET /v1/loyalty_programs/{programID}/profile/{integrationID} get the Loyalty Ledger for this integrationID
ManagementApi getLoyaltyProgram GET /v1/loyalty_programs/{programID} Get a loyalty program
ManagementApi getLoyaltyPrograms GET /v1/loyalty_programs List all loyalty Programs
ManagementApi getReferrals GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals List Referrals
ManagementApi getReferralsWithoutTotalCount GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total List Referrals
ManagementApi getRole GET /v1/roles/{roleId} Get information for the specified role.
ManagementApi getRuleset GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Get a Ruleset
ManagementApi getRulesets GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets List Campaign Rulesets
ManagementApi getUser GET /v1/users/{userId} Get a single User
ManagementApi getUsers GET /v1/users List Users in your account
ManagementApi getWebhook GET /v1/webhooks/{webhookId} Get Webhook
ManagementApi getWebhookActivationLogs GET /v1/webhook_activation_logs List Webhook activation Log Entries
ManagementApi getWebhookLogs GET /v1/webhook_logs List Webhook Log Entries
ManagementApi getWebhooks GET /v1/webhooks List Webhooks
ManagementApi refreshAnalytics POST /v1/refresh_analytics Trigger refresh on stale analytics.
ManagementApi removeLoyaltyPoints PUT /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points Deduct points in a certain loyalty program for the specified customer
ManagementApi resetPassword POST /v1/reset_password Reset password
ManagementApi searchCouponsAdvanced POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced Get a list of the coupons that match the given attributes
ManagementApi searchCouponsAdvancedApplicationWide POST /v1/applications/{applicationId}/coupons_search_advanced Get a list of the coupons that match the given attributes in all active campaigns of an application
ManagementApi searchCouponsAdvancedApplicationWideWithoutTotalCount POST /v1/applications/{applicationId}/coupons_search_advanced/no_total Get a list of the coupons that match the given attributes in all active campaigns of an application
ManagementApi searchCouponsAdvancedWithoutTotalCount POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total Get a list of the coupons that match the given attributes
ManagementApi setAccountLimits PUT /v1/accounts/{accountId}/limits Set account limits
ManagementApi updateCampaign PUT /v1/applications/{applicationId}/campaigns/{campaignId} Update a Campaign
ManagementApi updateCampaignSet PUT /v1/applications/{applicationId}/campaign_set Update a Campaign Set
ManagementApi updateCoupon PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} Update a Coupon
ManagementApi updateCouponBatch PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Update a Batch of Coupons
ManagementApi updateRuleset PUT /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Update a Ruleset

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

integration_auth

  • Type: API key
  • API key parameter name: Content-Signature
  • Location: HTTP header

manager_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

You can’t perform that action at this time.