You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-52Lines changed: 14 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,20 @@
3
3
Talon.One API
4
4
- API version: 1.0.0
5
5
6
-
The Talon.One API is used to manage applications and campaigns, as well as to
7
-
integrate with your application. The operations in the _Integration API_ section
8
-
are used to integrate with our platform, while the other operations are
9
-
used to manage applications and campaigns.
6
+
Use the Talon.One API to integrate with your application and to
7
+
manage applications and campaigns:
10
8
11
-
### Where is the API?
9
+
- Use the operations in the [Integration API section](#integration-api)
10
+
are used to integrate with our platform
11
+
- Use the operation in the [Management API section](#management-api) to
12
+
manage applications and campaigns.
12
13
13
-
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`
The API is available at the same hostname as your Campaign Manager deployment.
17
+
For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`,
18
+
the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint
19
+
is `https://mycompany.talon.one/v2/customer_sessions/{Id}`
16
20
17
21
18
22
@@ -81,7 +85,7 @@ Please follow the [installation](#installation) instruction and execute the foll
81
85
82
86
### Integration API
83
87
84
-
#### V2
88
+
**Note:** The Integration API's V1 `Update customer session` and `Update customer profile` endpoints are now deprecated. Use their V2 instead. See [Migrating to V2](https://docs.talon.one/docs/dev/tutorials/migrating-to-v2) for more information.
*IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
257
221
*IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
258
222
*IntegrationApi* | [**trackEvent**](docs/IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
*ManagementApi* | [**addLoyaltyPoints**](docs/ManagementApi.md#addLoyaltyPoints) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
266
228
*ManagementApi* | [**copyCampaignToApplications**](docs/ManagementApi.md#copyCampaignToApplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
0 commit comments