Authentication
To get started using our API, first generate your API key. To do that, in your admin dashboard click on "Generate API key" link on the right. Then you'll need to call our GetApiToken method with your API key to get your temporary authentication token. The lifetime of the token is 240 minutes. When calling our API methods, you will need to include this token in a Request Header "Authentication" field (Authentication: token).
| API Methods | Description |
|---|---|
| GET authentication/getapitoken?key={key} |
Authentication method gets the temporary token for API access. The lifetime of the token is 240 minutes. When calling our API methods, you will need to include this token in a Request Header "Authentication" field. |
AccountPlan
API methods for working with account plans
| API Methods | Description |
|---|---|
| GET accountplans/{accountid}?accounttype={accounttype} |
Returns the list of Basic or Premium account plans |
Account
API methods for working with accounts
| API Methods | Description |
|---|---|
| PUT accounts |
Creates an account in our platform and returns an Account object with account id |
| GET accounts?externalid={externalid}&skip={skip}&take={take} |
Returns the list of Basic and Premium accounts for a given external id with sub-accounts and sites. Note: for efficiency this API method can only return up to 500 records at a time. Use the skip and take parameters to return more records. |
| GET accounts?skip={skip}&take={take} |
Returns the list of Basic and Premium accounts with sub-accounts and sites. Note: for efficiency this API method can only return up to 500 records at a time. Use the skip and take parameters to return more records. |
| GET accounts/{accountid} |
Returns the information on the account |
| POST accounts/{accountid} |
Changes information fields for an account. |
| GET accounts/{accountid}/getaccessurl |
Creates a temporary login link for authentication to a specific account. The lifetime of this login link is 2 minutes. |
| POST accounts/{accountid}/changeexternalid/{externalid} |
Changes the external id for an account. An 'external id' is an id of this account in your system. |
| POST accounts/{accountid}/changeaccountstatus/{status} |
Changes the status for the account |
| POST accounts/{accountid}/changeaccountplan/{accountplanid} |
Changes (upgrades or downgrades) the plan of the account |
| POST accounts/{accountid}/movebasicaccount/{destinationaccountid} |
Moves a Basic account (sub-account) to another Premium account (multi-user account). The destination Premium account must exist in our platform. |
| DELETE accounts/{accountid}/deletebasicaccount |
Deletes the Basic account |
BusinessCategory
API methods for working with business categories
| API Methods | Description |
|---|---|
| GET businesscategories/{accountid} |
Returns the list of business categories |
Site
API methods for working with sites (domains)
| API Methods | Description |
|---|---|
| PUT sites |
Creates a site on the Basic account (sub-account). |
| GET sites/{siteid} |
Get site information |
| GET sitebydomain/{domain} |
Get site information. For branch API keys only. |
| POST sites/{siteid} |
Update site information |
| DELETE sites/{siteid} |
Delete specified site |
Template
API methods for working with templates.
| API Methods | Description |
|---|---|
| GET templates/containers/{containerid}/fields |
Returns a list of data fields created for this container. |
| GET templates/pagetemplates?accountid={accountid} |
Returns a list of API page templates |
| GET templates/pagetemplates/getgeneratepagesstatus?jobid={jobid} |
Returns the current status of a page generation task |
| POST templates/containers/{containerid}/generatepages |
This method generates pages based on the data previously loaded into a data container. |
| GET templates/containers?accountid={accountid} |
Returns a list of data containers |
| POST templates/containers/{containerid}/loaddataitems |
Validates and loads your data (data items) into a data container. Once the data is loaded, you can call the /GeneratePages/ method to generate the pages for these data items. |
| GET templates/containers/{containerid}/getdataitems |
This method returns all data items created within this data container. |
| DELETE templates/containers/{containerid}/{itemid} |
This method delete a data item in this data container. |
| DELETE templates/containers/{containerid}/generatedpage/{itemid} |
This method delete a page generated for this data item in this data container. |
Location
API methods for working with templates.
| API Methods | Description |
|---|---|
| POST templates/locations/AddLocationSet?accountid={accountid} |
Create location set |
| GET templates/locations/GetLocationSets?accountid={accountid} |
Get location sets |
| POST templates/locations/DeleteLocationSet?locationSetId={locationSetId}&accountid={accountid} |
Delete location set |
| POST templates/locations/UpdateLocationSet?accountid={accountid} |
Update location set |
| POST templates/locations/AddLocationItem?locationSetId={locationSetId}&accountid={accountid} |
Create location item for location set |
| GET templates/locations/GetLocationItem?itemId={itemId}&accountid={accountid} |
Get location item |
| GET templates/locations/GetLocationItems?locationSetId={locationSetId}&accountid={accountid} |
Get location items |
| POST templates/locations/UpdateLocationItem?accountid={accountid} |
Update location item |
| POST templates/locations/DeleteLocationItem?itemId={itemId}&accountid={accountid} |
Delete location item |
LoyaltyProgram
API methods for working with the loyalty program
| API Methods | Description |
|---|---|
| PUT loyaltyprogram/members/{accountid} |
Register a loyalty program member |
| POST loyaltyprogram/members/count |
Returns the member counts of loyalty programs. The method takes a list of Basic account Ids and returns the loyalty program member counts for these accounts. |
| POST loyaltyprogram/email/info |
Returns the email marketing information for a list of loyalty programs. The method takes a list of Basic account Ids and returns the loyalty program email marketing information for these accounts. |
| POST loyaltyprogram/members/{accountid} |
Update a loyalty program member |
| GET loyaltyprogram/members/{accountid}/{memberid} |
Returns a member object containing the member information |
| GET loyaltyprogram/members/{accountid}/phone/{memberphone} |
Returns a member object containing the member information |
| GET loyaltyprogram/members/{accountid}?skip={skip}&take={take} |
Returns a list of members within a loyalty program |
| GET loyaltyprogram/employees/{accountid}?skip={skip}&take={take} |
Returns a list of authorized employees within a loyalty program |
| GET loyaltyprogram/actions/{accountid} |
Returns a list of bonus actions configured for a loyalty program |
| GET loyaltyprogram/rewards/{accountid} |
Returns a list of rewards configured for a loyalty program |
| GET loyaltyprogram/stores/{accountid} |
Returns a list of stores configured for a loyalty program |
| POST loyaltyprogram/enterpoints/{accountid}?isPunch={isPunch} |
Enter points for a loyalty program member |
| POST loyaltyprogram/enteraction/{accountid} |
Record a bonus action for a loyalty program member |
| POST loyaltyprogram/enterredemption/{accountid} |
Record a reward redemption for a loyalty program member |
| POST loyaltyprogram/entercorrection/{accountid} |
Record a correction transaction for a loyalty program member |