LogBuy API help page

Introduction

Your guide to getting the most out of the API

With the LogBuy API you can develop a custom app. A custom app can be a program or a connection that allows exchange of data between LogBuy and another program, e.g. an intranet or smart phone app. The connection automates many tasks between the two systems so customers can spend less time on manual tasks and present exciting content directly in their own environment. With an app, you can exchange data between the two systems, allowing you to either extract information from LogBuy (e.g. deals and discounts) or transfer information to LogBuy (e.g. user data) – or both.

You need to be a LogBuy customer in order to interact with the API. A key is needed to exchange information between your system and the API.

API	Description
POST token	Request Token
POST api/login/requestpassword?email={email}	Request password. Email is sent to user if user is registered in the system
POST api/login/updateStatistics	Set Statistics of Logins by UserProfile
POST api/login/changepassword	Change password. Deprecated, use route api/userprofile/ChangePassword instead.
POST api/login/logout	LogOut
GET api/account/externallogins?returnUrl={returnUrl}&generateState={generateState}	Method to get facebook access token. Obsolete since registration and login with facebook are deprecated.
GET api/login/contactUs?countryId={countryId}	Get contact information

Registration

Provides routes to create user profile

API	Description
POST api/registration/CreateUserProfile?countryId={countryId}	Create User Profile. If result of creating user profile is true, User should wait for approval from Logbuy. When profile is approved, User will receive email about success or reject for approval. User can login into the system just after approval.
POST api/registration/CreateExternalUserProfile?countryId={countryId}	Creation user from external provider with Facebook. Authorization by token is required. Obsolete since registration and login with facebook are deprecated.
POST api/registration/CreateBiometricUserProfile?countryId={countryId}&languageId={languageId}	Creation user from external provider with device Biometric. Authorization by token is required. Registration with biometric device is deprecated.
POST api/registration/ValidateEmail?countryId={countryId}	Validates email: only valid emails checked with Regex are accepted, declined or non-approved users. Authorization by token is required.
POST api/registration/IsEmailMultiAccount	Check if email is multi account. Authorization by token is required.

Activation

Provides routes for user profile activation

API	Description
POST api/activation/userProfile	Activate user profile and in case of success user will get welcome email back. Use grant type accesskey for authorization

UserProfile

Provides routes to access the user profile data

API	Description
GET api/userprofile/MultiAccount	Get User Multi-Accounts
PUT api/userprofile/MultiAccount	Set Current User Multi-Account
GET api/userprofile/ContentSetConfigs	Get ContentSet Setting Per User
GET api/userprofile/DataSync	DataSync
GET api/userprofile	Get User Profile Info
POST api/userprofile	Update User Profile Info
DELETE api/userprofile/DeleteMe	Endpoint allows to delete own self and do logout
DELETE api/userprofile/DeleteMeFull	Endpoint allows to delete all accounts and do logout
POST api/userprofile/ChangePassword	Change User Password
POST api/userprofile/UpdateBankInfo	Update Bank Information
GET api/userprofile/AllowedLanguages	Get Allowed Languages
PUT api/userprofile/UpdateLanguage	Update User Language
PUT api/userprofile/Facebook	Allow Facebook Login. Obsolete since registration and login with facebook are deprecated.
DELETE api/userprofile/Facebook	Remove relation between facebook account and user account. User will not be able to login with facebook if relation with facebook account is removed. Obsolete since registration and login with facebook are deprecated
PUT api/userprofile/Biometric	Allow Biometric Login
PUT api/userprofile/UseSmartPhone	Store user device, is app install or not
DELETE api/userprofile/Biometric	Remove relation between device biometric token and user account. User will not be able to login with biometric if relation with biometric token is removed
PUT api/userprofile/Image	Upload Front User Profile Image. file should be provided as a multipart content. Parameter name "file" (double quotes are a part of parameter name).
DELETE api/userprofile/Image	Remove user profile image
PUT api/userprofile/buyerInfo	Update user info - for purchase
GET api/userprofile/buyerInfo	Get user info - for purchase
GET api/userprofile/purchasehistory	Get Purchase history
GET api/userprofile/purchasehistory/shoppingCard?giftCardId={giftCardId}	Purchase Shopping Card History
GET api/userprofile/purchasehistory/eVoucher?eVoucherCodeId={eVoucherCodeId}	Get EVoucher PDF
GET api/userprofile/purchasehistory/eVoucherInBytes?eVoucherCodeId={eVoucherCodeId}	Get EVoucher PDF in Bytes
GET api/userprofile/purchasehistory/overview	Get Purchase History Overview
GET api/userprofile/purchasehistory/balance	Get Balance amount. Balance amount is cashback amount that will be returned to user from provider website
POST api/userprofile/withdraw	Method allows user to request cashback Balance amount to Bank account if Balance is not zero.
GET api/userprofile/prefferedlocation	Get User Preferred Location
POST api/userprofile/prefferedlocation	Update User Preferred Location
POST api/userprofile/updatecontentset	Update user's current content set
POST api/userprofile/disableUsersUpdateEmail	Method allows user to enable/disable option for updating emails for specific customers.

BenefitCard

API	Description
GET api/benefitcard	Get Benefit Card Information

Agreements

API	Description
GET api/Terms?countryId={countryId}	Get latest terms and conditions by countryId. Each user must accept terms and conditions. Authorization by token is required.
POST api/Terms/Accept/{id}	Accept Terms and Conditions. Authorization by token is required.
GET api/policy	Get Privacy policy information

Support

Provides routes to add comments or provide a feedback

API	Description
POST api/support/Comment	Add Comment
POST api/support/SuggestDeal	Suggest a Deal

Country

API	Description
GET api/Country	Get all available Countries
GET api/countryByUser	Get country by user profile

Customer

API	Description
GET api/Customer?countryId={countryId}&term={term}&resultItemsAmount={resultItemsAmount}	Get list of Customers by CountryId and term

Location

API	Description
GET api/City?countryId={countryId}&term={term}&resultItemsAmount={resultItemsAmount}	Get Locations (list of cities) by Country Id

Suppliers

Provides routes to access the suppliers data

API	Description
GET api/suppliers/{id}	Get Supplier Details
GET api/suppliers/{id}/info?addressId={addressId}	Get Supplier Details
GET api/suppliers/{supplierId}/OnContentSet/{isOnContentSet}	Get Supplier Details
POST api/suppliers/{id}/GetOrderedAddressesByGeo	Get Supplier Addresses And Sort It By Geo Location
POST api/suppliers/{id}/GetOrderedAddressesByGeo/OnContentSet/{isOnContentSet}	Get Supplier Addresses And Sort It By Geo Location
GET api/suppliers/topSearchWords	Get Top Search Words
GET api/suppliers/topSearchWords/{amountWords}	Get Top Search Words
GET api/suppliers/topSearchWords/{amountWords}/OnContentSet/{isOnContentSet}	Get Top Search Words
GET api/suppliers/url?supplierId={supplierId}&dealId={dealId}	Get Go To web site link
GET api/suppliers/terms?supplierId={supplierId}&dealId={dealId}	Get Terms And Conditions
GET api/suppliers/terms/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Terms And Conditions
GET api/suppliers/{id}/info/OnContentSet/{isOnContentSet}?addressId={addressId}	Get Supplier Details
POST api/suppliers/search	Search Suppliers
POST api/suppliers/availableFilters	Gets list of available filters
POST api/suppliers/searchmap	Search Suppliers for Map
GET api/suppliers/{supplierId}/SearchMapDetails/{addressId}	Search Suppliers Details for Map
GET api/suppliers/{supplierId}/SearchMapDetails/{addressId}/OnContentSet/{isOnContentSet}	Search Suppliers Details for Map
POST api/suppliers/frontpage	Get FrontPage suppliers
POST api/suppliers/promoted	Get Promoted Suppliers
POST api/suppliers/featured	Get Featured Suppliers
GET api/suppliers/{supplierId}/addresses/{addressId}	Get Address Details
GET api/suppliers/{supplierId}/addresses/{addressId}/OnContentSet/{isOnContentSet}	Get Address Details
GET api/suppliers/{supplierId}/addresses/{addressId}/playdates	Get play dates for culture deals
GET api/suppliers/{supplierId}/addresses/{addressId}/playdates/OnContentSet/{isOnContentSet}	Get play dates for culture deals
POST api/suppliers/sendlink	Send link on supplier to user in email
POST api/suppliers/suggest	Suggest customer and tags
POST api/suppliers/overview	Get Overview
POST api/suppliers/homepage	Get Home Page
GET api/suppliers/browsepage	Get Browse Page
GET api/suppliers/browsepage/OnContentSet/{isOnContentSet}	Get Browse Page
GET api/suppliers/topbanners?topBannerLocationFilter={topBannerLocationFilter}	Get Top Banners

Cashback

API	Description
POST api/cashback/buy	Get redirect link to cashback partner website. Unique number is saved for each calling of this method to receive information about purchase from provider website

Favorites

API	Description
POST api/favorites/search	Get Favorites Suppliers
POST api/favorites/{supplierId}	Add Supplier to Favorites
POST api/favorites/{supplierId}/OnContentSet/{isOnContentSet}	Add Supplier to Favorites
DELETE api/favorites/{supplierId}	Remove Supplier from Favorites list
DELETE api/favorites/{supplierId}/OnContentSet/{isOnContentSet}	Remove Supplier from Favorites list
POST api/favorites/remove	Remove Suppliers from Favorites list

DealTypes

API	Description
GET api/dealtypes	Get available deal types depends on user access to suppliers/deal

API	Description
GET api/categories	Get Categories
GET api/categories/OnContentSet/{isOnContentSet}	Get Categories <param name="isOnContentSet">Turn On to use ContentSet options</param>
GET api/categories/LeadFamlyCampaign	Get Lead Famly campaign section. Response is cached for 5 minutes in application and distributed cache.

Themes

Provides routes to access themes data

API	Description
GET api/themes	Get Themes
GET api/themes/OnContentSet/{isOnContentSet}	Get Themes <param name="isOnContentSet">Turn On to use ContentSet options</param>

Brands

API	Description
GET api/brands	Get brands

Deparments

API	Description
GET api/departments	Get departments

Purchase

API	Description
POST api/order/beginPayment	Method to start payment process
GET api/order/PaymentInfo	Get Payment Info
GET api/order/seller	Get Seller Info
POST api/order/shippings	Get available shipping options for current order
POST api/order/shippings/OnContentSet/{isOnContentSet}	Get available shipping options for current order
GET api/order/paymentCardFee	Get Payment Card Fee. Payment Card fee is price for using credit cards during purchase and should be included to Total price

EVoucher

API	Description
GET api/evoucher/maxquantity?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of eVouchers to Buy
GET api/evoucher/maxquantity/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of eVouchers to Buy
GET api/evoucher/buy?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of eVouchers to Buy
GET api/evoucher/buy/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of eVouchers to Buy
PUT api/evoucher/book?supplierId={supplierId}&dealId={dealId}&quantity={quantity}	eVoucher reservation, set the amount of vouchers reserved by current user
PUT api/evoucher/book/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}&quantity={quantity}	eVoucher reservation, set the amount of vouchers reserved by current user

ShoppingCard

API	Description
GET api/shoppingcard/maxquantity?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of shopping cards to Buy
GET api/shoppingcard/maxquantity/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of shopping cards to Buy
GET api/shoppingcard/buy?supplierId={supplierId}&dealId={dealId}	Get Shopping card info to Buy
GET api/shoppingcard/buy/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Shopping card info to Buy
GET api/shoppingcard/topUp?supplierId={supplierId}&dealId={dealId}	Get Shopping card info to Top Up
GET api/shoppingcard/topUp/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Shopping card info to Top Up

Receipt

API	Description
GET api/receipt?transactionId={transactionId}	Get receipt when buy shopping card, eVoucher, upgrade to private membership

Statistics

API	Description
GET api/statistics/portal?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/portal/toplists?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/portal/login?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/portal/uniquelogin?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/portal/dealclicks?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/portal/partnerdealclicks?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/activated?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/active?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/created?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/deleted?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/total?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/users/newsletter?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/usersavings?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/usersavings/purchase?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/usersavings/savings?fromDate={fromDate}&toDate={toDate}&countryId={countryId}&defaultPortalId={defaultPortalId}&customerId={customerId}
GET api/statistics/countries	Get available Countries
GET api/statistics/defaultportals?countryId={countryId}	Get available Default Portals
GET api/statistics/customers?countryId={countryId}&defaultPortalId={defaultPortalId}	Get Available Customers
POST api/statistics/useBenefitCard	Update Statistics By Use Benefit Card

PrivateMembership

API	Description
GET api/privatemembership	Get Private Membership Info
POST api/privatemembership/startrenewal	Start Automatic membership Renewal
POST api/privatemembership/stoprenewal	Stop Automatic membership Renewal
GET api/privatemembership/terms	Get private membership Terms and Conditions. User must accept during purchase private membership
GET api/privatemembership/upgrade/info	Information about price and additional charges for upgrading to private membership
POST api/privatemembership/upgrade	Upgarde to private membership (Begin Payment)

UserManagement

Provides routes to access the users data

API	Description
POST api/users/import?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}	Imports a list of users into the system.
POST api/users/deleteUsers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}	Remove users
POST api/users/deleteUsersBySalaryNumbers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}	Delete users by salary numbers
POST api/users/enableUsers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}	Enable users
POST api/users/enableUsersBySalaryNumbers?customerId={customerId}&countryId={countryId}&defaultPortalId={defaultPortalId}	Enable users

FollowUs

API	Description
POST api/followus	Get list with all LogBuy Social networks with links and icons type

PromoCode

Provides routes for promo codes

API	Description
GET api/promocode/maxquantity/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}	Get Max Allowed Quantity of Promo Codes per user
GET api/promocode/OnContentSet/{isOnContentSet}?supplierId={supplierId}&dealId={dealId}&isNewOne={isNewOne}	Get Promo Code
PUT api/promocode/PromoCodeUsed	Promo Code Used Info

BrowserExtension

Provides routes for Browser Extension

API	Description
GET api/browserExtension/activeDeals	Get Active Deals By User

NewAndHot

Provides routes to get new and hot deals data

API	Description
POST api/NewAndHot/homepage	Get Home Page
GET api/NewAndHot/CategoriesOrder/OnContentSet/{isOnContentSet}	Get Order for Categories Per User
POST api/NewAndHot/CategoriesOrder	Set Order for Categories Per User
DELETE api/NewAndHot/RemoveCategoriesOrder	Set Default setting for Categories Order

Notifications

Provides actions for AppCenterUsersNotifications

API	Description
POST api/notifications/types	Update status for the notification setting per user
POST api/appcenter/identify	Mobile devices identification
POST api/notifications/register	Mobile devices registration
GET api/notifications/types	Get Status of the notification setting per user
GET api/notifications?pageNumber={pageNumber}&pageSize={pageSize}	Get list of the notifications previously sent to the user
GET api/notifications/OnContentSet/{isOnContentSet}?pageNumber={pageNumber}&pageSize={pageSize}	Get list of the notifications previously sent to the user
DELETE api/notifications/{id}	Delete the notification by id
POST api/notifications/read/{id}	Set Up Notification As Read
POST api/notifications/readAll	Set Up All Notification As Read
GET api/notifications/unreadCount	Get Count Of Unread Notifications Per User
GET api/notifications/unreadCount/OnContentSet/{isOnContentSet}	Get Count Of Unread Notifications Per User
GET api/notifications/unread	Get ids of Unread Notifications Per User

AIAssistant

Provides AI Assistant functionality

API	Description
GET api/chatbotHistory/{session_id}	Get Chatbot History by Session ID
DELETE api/chatbotHistory/{session_id}	Delete Chatbot History by Session ID
POST api/chatbotHistoryBulkClear	Bulk Clear Chatbot History
POST api/chatbot	Get Chatbot
POST api/chatbotStream	Get Chatbot Stream
GET api/sessionsHistory	Sessions History by User ID
POST api/SetSessionName	Set Session Name
POST api/feedback	Feedback by User
GET api/feedbacks/{session_id}	Get Feedbacks by User and Session ID

AppCompetition

API	Description
POST api/competitions/interaction	Add competition participant
GET api/competitions?pageNumber={pageNumber}&pageSize={pageSize}	Get list of the competition notifications previously sent to the user
POST api/competitions/read/{id}	Set Up Competition As Read
GET api/competitions/unread	Get ids of Unread Competitions Per User

AppCampaign

Provides routes to get the App Campaign data

API	Description
GET api/appcampaign/campaign?width={width}&height={height}	Returns App Campaign data
GET api/appcampaign/campaign/OnContentSet/{isOnContentSet}?width={width}&height={height}	Returns App Campaign data