Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Talon.One API SDK for Ruby

NotificationsYou must be signed in to change notification settings

talon-one/talon_one.rb

Repository files navigation

This SDK supports all of the operations of Talon.One's Integration API and Management API.

Installation

Gemfile

Add this to the Gemfile:

gem'talon_one','~> 10.0.0'

Build a gem

To build the Ruby code into a gem:

gem build talon_one.gemspec

Local installation

To install the gem locally:

gem install ./talon_one-10.0.0.gem

For development, rungem install --dev ./talon_one-10.0.0.gem to install the development dependencies.

RubyGems

The SDK is available onRubyGems. To install it, run:

gem install talon_one

Getting started

Integration API

The following code shows an example of using the Integration API:

# Load the gemrequire'talon_one'# Setup authorizationTalonOne.configuredo |config|# Configure the API host destination while explicitly using HTTPS as the default is HTTP.config.scheme='https'config.host='yourbaseurl.talon.one'# Configure API key authorization: api_key_v1config.api_key['Authorization']='ca1890f0ec3bfa8ed4be04e2aec0c606c0df8ad464f17d3ea8b51df12ba60e5d'config.api_key_prefix['Authorization']='ApiKey-v1'end# Integration API example to send a session updateintegration_api=TalonOne::IntegrationApi.newsession_integration_id='8fb7129e-68e6-4464-9631-09b588391619'# String | The integration identifier of the session# NewCustomerSessionV2 objectcustomer_session_v2=TalonOne::NewCustomerSessionV2.new(profile_id:'Some_1',state:'open',cart_items:[TalonOne::CartItem.new(name:'Nigiri Sake',sku:'sush1',quantity:2,price:3.7,category:'Sushi'),TalonOne::CartItem.new(name:'Rainbow Roll I/O',sku:'sush2',quantity:1,price:6.5,category:'Sushi'),TalonOne::CartItem.new(name:'Kirin',sku:'k1r',quantity:2,price:2.2,category:'Beverages'),],coupon_codes:['Cool-Stuff!'])# Instantiating a new IntegrationRequest objectintegration_request=TalonOne::IntegrationRequest.new(customer_session:customer_session_v2,# Optional list of requested information to be present on the response.# See docs/IntegrationRequest.md for full list# response_content: [#  'customerSession'# ])begin# Create/update a customer session using `update_customer_session_v2` functionresult=integration_api.update_customer_session_v2(session_integration_id,integration_request)# Prints response to the consoleputsresult# Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding propertiesresult.effects.eachdo |effect|ifeffect.effect_type =='setDiscount'# Initiating right props instance according to the effect typeprops=TalonOne::SetDiscountEffectProps.build_from_hash(effect.props)# Access the specific effect's propertiesputs"Set a discount '#{props.name}' of#{props.value}"elsifeffect.effect_type =='rejectCoupon'# Initiating right props instance according to the effect typeprops=TalonOne::RejectCouponEffectProps.build_from_hash(effect.props)# Work with AcceptCouponEffectProps' properties# ...endendrescueTalonOne::ApiError=>eputs"Exception when calling IntegrationApi->update_customer_session_v2:#{e}"end

Management API

The following code shows an example of using the Management API:

# Load the gemrequire'talon_one'# Setup authorizationTalonOne.configuredo |config|# Configure the API host destination and set scheme to HTTPSconfig.scheme='https'config.host='yourbaseurl.talon.one'# Configure API key authorization: management_keyconfig.api_key['Authorization']='2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07'config.api_key_prefix['Authorization']='ManagementKey-v1'end# Management API example to load application with id 7management_api=TalonOne::ManagementApi.newbegin# Calling get_application function with the desired id (7)result=management_api.get_application(7)# Print result to the consoleputsresultrescueTalonOne::ApiError=>eputs"Exception when calling ManagementApi:#{e}"end

Documentation for API endpoints

All URLs are relative tohttps://yourbaseurl.talon.one.

ClassMethodHTTP requestDescription
TalonOne::IntegrationApicreate_audience_v2POST /v2/audiencesCreate audience
TalonOne::IntegrationApicreate_coupon_reservationPOST /v1/coupon_reservations/{couponValue}Create coupon reservation
TalonOne::IntegrationApicreate_referralPOST /v1/referralsCreate referral code for an advocate
TalonOne::IntegrationApicreate_referrals_for_multiple_advocatesPOST /v1/referrals_for_multiple_advocatesCreate referral codes for multiple advocates
TalonOne::IntegrationApidelete_audience_memberships_v2DELETE /v2/audiences/{audienceId}/membershipsDelete audience memberships
TalonOne::IntegrationApidelete_audience_v2DELETE /v2/audiences/{audienceId}Delete audience
TalonOne::IntegrationApidelete_coupon_reservationDELETE /v1/coupon_reservations/{couponValue}Delete coupon reservations
TalonOne::IntegrationApidelete_customer_dataDELETE /v1/customer_data/{integrationId}Delete customer's personal data
TalonOne::IntegrationApigenerate_loyalty_cardPOST /v1/loyalty_programs/{loyaltyProgramId}/cardsGenerate loyalty card
TalonOne::IntegrationApiget_customer_achievement_historyGET /v1/customer_profiles/{integrationId}/achievements/{achievementId}List customer's achievement history
TalonOne::IntegrationApiget_customer_achievementsGET /v1/customer_profiles/{integrationId}/achievementsList customer's available achievements
TalonOne::IntegrationApiget_customer_inventoryGET /v1/customer_profiles/{integrationId}/inventoryList customer data
TalonOne::IntegrationApiget_customer_sessionGET /v2/customer_sessions/{customerSessionId}Get customer session
TalonOne::IntegrationApiget_loyalty_balancesGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balancesGet customer's loyalty balances
TalonOne::IntegrationApiget_loyalty_card_balancesGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balancesGet card's point balances
TalonOne::IntegrationApiget_loyalty_card_pointsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/pointsList card's unused loyalty points
TalonOne::IntegrationApiget_loyalty_card_transactionsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactionsList card's transactions
TalonOne::IntegrationApiget_loyalty_program_profile_pointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/pointsList customer's unused loyalty points
TalonOne::IntegrationApiget_loyalty_program_profile_transactionsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactionsList customer's loyalty transactions
TalonOne::IntegrationApiget_reserved_customersGET /v1/coupon_reservations/customerprofiles/{couponValue}List customers that have this coupon reserved
TalonOne::IntegrationApilink_loyalty_card_to_profilePOST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profileLink customer profile to card
TalonOne::IntegrationApireopen_customer_sessionPUT /v2/customer_sessions/{customerSessionId}/reopenReopen customer session
TalonOne::IntegrationApireturn_cart_itemsPOST /v2/customer_sessions/{customerSessionId}/returnsReturn cart items
TalonOne::IntegrationApisync_catalogPUT /v1/catalogs/{catalogId}/syncSync cart item catalog
TalonOne::IntegrationApitrack_event_v2POST /v2/eventsTrack event
TalonOne::IntegrationApiupdate_audience_customers_attributesPUT /v2/audience_customers/{audienceId}/attributesUpdate profile attributes for all customers in audience
TalonOne::IntegrationApiupdate_audience_v2PUT /v2/audiences/{audienceId}Update audience name
TalonOne::IntegrationApiupdate_customer_profile_audiencesPOST /v2/customer_audiencesUpdate multiple customer profiles' audiences
TalonOne::IntegrationApiupdate_customer_profile_v2PUT /v2/customer_profiles/{integrationId}Update customer profile
TalonOne::IntegrationApiupdate_customer_profiles_v2PUT /v2/customer_profilesUpdate multiple customer profiles
TalonOne::IntegrationApiupdate_customer_session_v2PUT /v2/customer_sessions/{customerSessionId}Update customer session
TalonOne::ManagementApiactivate_user_by_emailPOST /v1/users/activateEnable user by email address
TalonOne::ManagementApiadd_loyalty_card_pointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_pointsAdd points to card
TalonOne::ManagementApiadd_loyalty_pointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_pointsAdd points to customer profile
TalonOne::ManagementApicopy_campaign_to_applicationsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/copyCopy the campaign into the specified Application
TalonOne::ManagementApicreate_account_collectionPOST /v1/collectionsCreate account-level collection
TalonOne::ManagementApicreate_achievementPOST /v1/applications/{applicationId}/campaigns/{campaignId}/achievementsCreate achievement
TalonOne::ManagementApicreate_additional_costPOST /v1/additional_costsCreate additional cost
TalonOne::ManagementApicreate_attributePOST /v1/attributesCreate custom attribute
TalonOne::ManagementApicreate_batch_loyalty_cardsPOST /v1/loyalty_programs/{loyaltyProgramId}/cards/batchCreate loyalty cards
TalonOne::ManagementApicreate_campaign_from_templatePOST /v1/applications/{applicationId}/create_campaign_from_templateCreate campaign from campaign template
TalonOne::ManagementApicreate_campaign_store_budgetPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsCreate campaign store budget
TalonOne::ManagementApicreate_collectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsCreate campaign-level collection
TalonOne::ManagementApicreate_couponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/couponsCreate coupons
TalonOne::ManagementApicreate_coupons_asyncPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_asyncCreate coupons asynchronously
TalonOne::ManagementApicreate_coupons_deletion_jobPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobsCreates a coupon deletion job
TalonOne::ManagementApicreate_coupons_for_multiple_recipientsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipientsCreate coupons for multiple recipients
TalonOne::ManagementApicreate_invite_emailPOST /v1/invite_emailsResend invitation email
TalonOne::ManagementApicreate_invite_v2POST /v2/invitesInvite user
TalonOne::ManagementApicreate_password_recovery_emailPOST /v1/password_recovery_emailsRequest a password reset
TalonOne::ManagementApicreate_sessionPOST /v1/sessionsCreate session
TalonOne::ManagementApicreate_storePOST /v1/applications/{applicationId}/storesCreate store
TalonOne::ManagementApideactivate_user_by_emailPOST /v1/users/deactivateDisable user by email address
TalonOne::ManagementApideduct_loyalty_card_pointsPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_pointsDeduct points from card
TalonOne::ManagementApidelete_account_collectionDELETE /v1/collections/{collectionId}Delete account-level collection
TalonOne::ManagementApidelete_achievementDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Delete achievement
TalonOne::ManagementApidelete_campaignDELETE /v1/applications/{applicationId}/campaigns/{campaignId}Delete campaign
TalonOne::ManagementApidelete_campaign_store_budgetsDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsDelete campaign store budgets
TalonOne::ManagementApidelete_collectionDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Delete campaign-level collection
TalonOne::ManagementApidelete_couponDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Delete coupon
TalonOne::ManagementApidelete_couponsDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/couponsDelete coupons
TalonOne::ManagementApidelete_loyalty_cardDELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Delete loyalty card
TalonOne::ManagementApidelete_referralDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Delete referral
TalonOne::ManagementApidelete_storeDELETE /v1/applications/{applicationId}/stores/{storeId}Delete store
TalonOne::ManagementApidelete_userDELETE /v1/users/{userId}Delete user
TalonOne::ManagementApidelete_user_by_emailPOST /v1/users/deleteDelete user by email address
TalonOne::ManagementApidestroy_sessionDELETE /v1/sessionsDestroy session
TalonOne::ManagementApidisconnect_campaign_storesDELETE /v1/applications/{applicationId}/campaigns/{campaignId}/storesDisconnect stores
TalonOne::ManagementApiexport_account_collection_itemsGET /v1/collections/{collectionId}/exportExport account-level collection's items
TalonOne::ManagementApiexport_achievementsGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/exportExport achievement customer data
TalonOne::ManagementApiexport_audiences_membershipsGET /v1/audiences/{audienceId}/memberships/exportExport audience members
TalonOne::ManagementApiexport_campaign_store_budgetsGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/exportExport campaign store budgets
TalonOne::ManagementApiexport_campaign_storesGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/exportExport stores
TalonOne::ManagementApiexport_collection_itemsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/exportExport campaign-level collection's items
TalonOne::ManagementApiexport_couponsGET /v1/applications/{applicationId}/export_couponsExport coupons
TalonOne::ManagementApiexport_customer_sessionsGET /v1/applications/{applicationId}/export_customer_sessionsExport customer sessions
TalonOne::ManagementApiexport_customers_tiersGET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiersExport customers' tier data
TalonOne::ManagementApiexport_effectsGET /v1/applications/{applicationId}/export_effectsExport triggered effects
TalonOne::ManagementApiexport_loyalty_balanceGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balanceExport customer loyalty balance to CSV
TalonOne::ManagementApiexport_loyalty_balancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balancesExport customer loyalty balances
TalonOne::ManagementApiexport_loyalty_card_balancesGET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balancesExport all card transaction logs
TalonOne::ManagementApiexport_loyalty_card_ledgerGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_logExport card's ledger log
TalonOne::ManagementApiexport_loyalty_cardsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/exportExport loyalty cards
TalonOne::ManagementApiexport_loyalty_ledgerGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_logExport customer's transaction logs
TalonOne::ManagementApiexport_pool_giveawaysGET /v1/giveaways/pools/{poolId}/exportExport giveaway codes of a giveaway pool
TalonOne::ManagementApiexport_referralsGET /v1/applications/{applicationId}/export_referralsExport referrals
TalonOne::ManagementApiget_access_logs_without_total_countGET /v1/applications/{applicationId}/access_logs/no_totalGet access logs for Application
TalonOne::ManagementApiget_accountGET /v1/accounts/{accountId}Get account details
TalonOne::ManagementApiget_account_analyticsGET /v1/accounts/{accountId}/analyticsGet account analytics
TalonOne::ManagementApiget_account_collectionGET /v1/collections/{collectionId}Get account-level collection
TalonOne::ManagementApiget_achievementGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Get achievement
TalonOne::ManagementApiget_additional_costGET /v1/additional_costs/{additionalCostId}Get additional cost
TalonOne::ManagementApiget_additional_costsGET /v1/additional_costsList additional costs
TalonOne::ManagementApiget_applicationGET /v1/applications/{applicationId}Get Application
TalonOne::ManagementApiget_application_api_healthGET /v1/applications/{applicationId}/health_reportGet Application health
TalonOne::ManagementApiget_application_customerGET /v1/applications/{applicationId}/customers/{customerId}Get application's customer
TalonOne::ManagementApiget_application_customer_friendsGET /v1/applications/{applicationId}/profile/{integrationId}/friendsList friends referred by customer profile
TalonOne::ManagementApiget_application_customersGET /v1/applications/{applicationId}/customersList application's customers
TalonOne::ManagementApiget_application_customers_by_attributesPOST /v1/applications/{applicationId}/customer_searchList application customers matching the given attributes
TalonOne::ManagementApiget_application_event_typesGET /v1/applications/{applicationId}/event_typesList Applications event types
TalonOne::ManagementApiget_application_events_without_total_countGET /v1/applications/{applicationId}/events/no_totalList Applications events
TalonOne::ManagementApiget_application_sessionGET /v1/applications/{applicationId}/sessions/{sessionId}Get Application session
TalonOne::ManagementApiget_application_sessionsGET /v1/applications/{applicationId}/sessionsList Application sessions
TalonOne::ManagementApiget_applicationsGET /v1/applicationsList Applications
TalonOne::ManagementApiget_attributeGET /v1/attributes/{attributeId}Get custom attribute
TalonOne::ManagementApiget_attributesGET /v1/attributesList custom attributes
TalonOne::ManagementApiget_audience_membershipsGET /v1/audiences/{audienceId}/membershipsList audience members
TalonOne::ManagementApiget_audiencesGET /v1/audiencesList audiences
TalonOne::ManagementApiget_audiences_analyticsGET /v1/audiences/analyticsList audience analytics
TalonOne::ManagementApiget_campaignGET /v1/applications/{applicationId}/campaigns/{campaignId}Get campaign
TalonOne::ManagementApiget_campaign_analyticsGET /v1/applications/{applicationId}/campaigns/{campaignId}/analyticsGet analytics of campaigns
TalonOne::ManagementApiget_campaign_by_attributesPOST /v1/applications/{applicationId}/campaigns_searchList campaigns that match the given attributes
TalonOne::ManagementApiget_campaign_groupGET /v1/campaign_groups/{campaignGroupId}Get campaign access group
TalonOne::ManagementApiget_campaign_groupsGET /v1/campaign_groupsList campaign access groups
TalonOne::ManagementApiget_campaign_templatesGET /v1/campaign_templatesList campaign templates
TalonOne::ManagementApiget_campaignsGET /v1/applications/{applicationId}/campaignsList campaigns
TalonOne::ManagementApiget_changesGET /v1/changesGet audit logs for an account
TalonOne::ManagementApiget_collectionGET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Get campaign-level collection
TalonOne::ManagementApiget_collection_itemsGET /v1/collections/{collectionId}/itemsGet collection items
TalonOne::ManagementApiget_coupons_without_total_countGET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_totalList coupons
TalonOne::ManagementApiget_customer_activity_reportGET /v1/applications/{applicationId}/customer_activity_reports/{customerId}Get customer's activity report
TalonOne::ManagementApiget_customer_activity_reports_without_total_countGET /v1/applications/{applicationId}/customer_activity_reports/no_totalGet Activity Reports for Application Customers
TalonOne::ManagementApiget_customer_analyticsGET /v1/applications/{applicationId}/customers/{customerId}/analyticsGet customer's analytics report
TalonOne::ManagementApiget_customer_profileGET /v1/customers/{customerId}Get customer profile
TalonOne::ManagementApiget_customer_profile_achievement_progressGET /v1/applications/{applicationId}/achievement_progress/{integrationId}List customer achievements
TalonOne::ManagementApiget_customer_profilesGET /v1/customers/no_totalList customer profiles
TalonOne::ManagementApiget_customers_by_attributesPOST /v1/customer_search/no_totalList customer profiles matching the given attributes
TalonOne::ManagementApiget_dashboard_statisticsGET /v1/loyalty_programs/{loyaltyProgramId}/dashboardGet statistics for loyalty dashboard
TalonOne::ManagementApiget_event_typesGET /v1/event_typesList event types
TalonOne::ManagementApiget_exportsGET /v1/exportsGet exports
TalonOne::ManagementApiget_loyalty_cardGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Get loyalty card
TalonOne::ManagementApiget_loyalty_card_transaction_logsGET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logsList card's transactions
TalonOne::ManagementApiget_loyalty_cardsGET /v1/loyalty_programs/{loyaltyProgramId}/cardsList loyalty cards
TalonOne::ManagementApiget_loyalty_pointsGET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}Get customer's full loyalty ledger
TalonOne::ManagementApiget_loyalty_programGET /v1/loyalty_programs/{loyaltyProgramId}Get loyalty program
TalonOne::ManagementApiget_loyalty_program_transactionsGET /v1/loyalty_programs/{loyaltyProgramId}/transactionsList loyalty program transactions
TalonOne::ManagementApiget_loyalty_programsGET /v1/loyalty_programsList loyalty programs
TalonOne::ManagementApiget_loyalty_statisticsGET /v1/loyalty_programs/{loyaltyProgramId}/statisticsGet loyalty program statistics
TalonOne::ManagementApiget_message_logsGET /v1/message_logsList message log entries
TalonOne::ManagementApiget_referrals_without_total_countGET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_totalList referrals
TalonOne::ManagementApiget_role_v2GET /v2/roles/{roleId}Get role
TalonOne::ManagementApiget_rulesetGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}Get ruleset
TalonOne::ManagementApiget_rulesetsGET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesetsList campaign rulesets
TalonOne::ManagementApiget_storeGET /v1/applications/{applicationId}/stores/{storeId}Get store
TalonOne::ManagementApiget_userGET /v1/users/{userId}Get user
TalonOne::ManagementApiget_usersGET /v1/usersList users in account
TalonOne::ManagementApiget_webhookGET /v1/webhooks/{webhookId}Get webhook
TalonOne::ManagementApiget_webhook_activation_logsGET /v1/webhook_activation_logsList webhook activation log entries
TalonOne::ManagementApiget_webhook_logsGET /v1/webhook_logsList webhook log entries
TalonOne::ManagementApiget_webhooksGET /v1/webhooksList webhooks
TalonOne::ManagementApiimport_account_collectionPOST /v1/collections/{collectionId}/importImport data into existing account-level collection
TalonOne::ManagementApiimport_allowed_listPOST /v1/attributes/{attributeId}/allowed_list/importImport allowed values for attribute
TalonOne::ManagementApiimport_audiences_membershipsPOST /v1/audiences/{audienceId}/memberships/importImport audience members
TalonOne::ManagementApiimport_campaign_store_budgetPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/importImport campaign store budgets
TalonOne::ManagementApiimport_campaign_storesPOST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/importImport stores
TalonOne::ManagementApiimport_collectionPOST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/importImport data into existing campaign-level collection
TalonOne::ManagementApiimport_couponsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_couponsImport coupons
TalonOne::ManagementApiimport_loyalty_cardsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_cardsImport loyalty cards
TalonOne::ManagementApiimport_loyalty_customers_tiersPOST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiersImport customers into loyalty tiers
TalonOne::ManagementApiimport_loyalty_pointsPOST /v1/loyalty_programs/{loyaltyProgramId}/import_pointsImport loyalty points
TalonOne::ManagementApiimport_pool_giveawaysPOST /v1/giveaways/pools/{poolId}/importImport giveaway codes into a giveaway pool
TalonOne::ManagementApiimport_referralsPOST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referralsImport referrals
TalonOne::ManagementApiinvite_user_externalPOST /v1/users/inviteInvite user from identity provider
TalonOne::ManagementApilist_account_collectionsGET /v1/collectionsList collections in account
TalonOne::ManagementApilist_achievementsGET /v1/applications/{applicationId}/campaigns/{campaignId}/achievementsList achievements
TalonOne::ManagementApilist_all_roles_v2GET /v2/rolesList roles
TalonOne::ManagementApilist_campaign_store_budget_limitsGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgetsList campaign store budget limits
TalonOne::ManagementApilist_catalog_itemsGET /v1/catalogs/{catalogId}/itemsList items in a catalog
TalonOne::ManagementApilist_collectionsGET /v1/applications/{applicationId}/campaigns/{campaignId}/collectionsList collections in campaign
TalonOne::ManagementApilist_collections_in_applicationGET /v1/applications/{applicationId}/collectionsList collections in Application
TalonOne::ManagementApilist_storesGET /v1/applications/{applicationId}/storesList stores
TalonOne::ManagementApiokta_event_handler_challengeGET /v1/provisioning/oktaValidate Okta API ownership
TalonOne::ManagementApiremove_loyalty_pointsPUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_pointsDeduct points from customer profile
TalonOne::ManagementApireset_passwordPOST /v1/reset_passwordReset password
TalonOne::ManagementApiscim_create_groupPOST /v1/provisioning/scim/GroupsCreate SCIM group
TalonOne::ManagementApiscim_create_userPOST /v1/provisioning/scim/UsersCreate SCIM user
TalonOne::ManagementApiscim_delete_groupDELETE /v1/provisioning/scim/Groups/{groupId}Delete SCIM group
TalonOne::ManagementApiscim_delete_userDELETE /v1/provisioning/scim/Users/{userId}Delete SCIM user
TalonOne::ManagementApiscim_get_groupGET /v1/provisioning/scim/Groups/{groupId}Get SCIM group
TalonOne::ManagementApiscim_get_groupsGET /v1/provisioning/scim/GroupsList SCIM groups
TalonOne::ManagementApiscim_get_resource_typesGET /v1/provisioning/scim/ResourceTypesList supported SCIM resource types
TalonOne::ManagementApiscim_get_schemasGET /v1/provisioning/scim/SchemasList supported SCIM schemas
TalonOne::ManagementApiscim_get_service_provider_configGET /v1/provisioning/scim/ServiceProviderConfigGet SCIM service provider configuration
TalonOne::ManagementApiscim_get_userGET /v1/provisioning/scim/Users/{userId}Get SCIM user
TalonOne::ManagementApiscim_get_usersGET /v1/provisioning/scim/UsersList SCIM users
TalonOne::ManagementApiscim_patch_groupPATCH /v1/provisioning/scim/Groups/{groupId}Update SCIM group attributes
TalonOne::ManagementApiscim_patch_userPATCH /v1/provisioning/scim/Users/{userId}Update SCIM user attributes
TalonOne::ManagementApiscim_replace_group_attributesPUT /v1/provisioning/scim/Groups/{groupId}Update SCIM group
TalonOne::ManagementApiscim_replace_user_attributesPUT /v1/provisioning/scim/Users/{userId}Update SCIM user
TalonOne::ManagementApisearch_coupons_advanced_application_wide_without_total_countPOST /v1/applications/{applicationId}/coupons_search_advanced/no_totalList coupons that match the given attributes (without total count)
TalonOne::ManagementApisearch_coupons_advanced_without_total_countPOST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_totalList coupons that match the given attributes in campaign (without total count)
TalonOne::ManagementApisummarize_campaign_store_budgetGET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summaryGet summary of campaign store budgets
TalonOne::ManagementApitransfer_loyalty_cardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transferTransfer card data
TalonOne::ManagementApiupdate_account_collectionPUT /v1/collections/{collectionId}Update account-level collection
TalonOne::ManagementApiupdate_achievementPUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}Update achievement
TalonOne::ManagementApiupdate_additional_costPUT /v1/additional_costs/{additionalCostId}Update additional cost
TalonOne::ManagementApiupdate_attributePUT /v1/attributes/{attributeId}Update custom attribute
TalonOne::ManagementApiupdate_campaignPUT /v1/applications/{applicationId}/campaigns/{campaignId}Update campaign
TalonOne::ManagementApiupdate_collectionPUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}Update campaign-level collection's description
TalonOne::ManagementApiupdate_couponPUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId}Update coupon
TalonOne::ManagementApiupdate_coupon_batchPUT /v1/applications/{applicationId}/campaigns/{campaignId}/couponsUpdate coupons
TalonOne::ManagementApiupdate_loyalty_cardPUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}Update loyalty card status
TalonOne::ManagementApiupdate_referralPUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}Update referral
TalonOne::ManagementApiupdate_role_v2PUT /v2/roles/{roleId}Update role
TalonOne::ManagementApiupdate_storePUT /v1/applications/{applicationId}/stores/{storeId}Update store
TalonOne::ManagementApiupdate_userPUT /v1/users/{userId}Update user

Documentation for models

Authorization

Authentication schemes defined for the API:

api_key_v1

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

management_key

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

manager_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
[8]ページ先頭
©2009-2025 Movatter.jp