Note: Only Store Owner users can create the API on Step 2.
Step 1: Add your site(s) on Toggle
The sites you'll be redeeming gift cards at need adding to Toggle. This step might already be done, but it's worth checking.
Log in to Toggle
On the sidebar click Settings > Site Settings and click Add site
Add the site name, its address, and any number or reference for it
Click the green Add button to save the site
Repeat this step for however many sites you need to add.
If needed here's more info on how to add sites (video included).
Example below:
Step 2: Create an API on Toggle (and get product ID and Account ID)
If needed here's more info on how to create the API (video included).
Log in to Toggle
On the sidebar click Settings > Integrations > Tevalis
Click create new user
Copy the username and then copy the password to this spreadsheet
Press Create to save the API*
⚠️ *Once you click create you can't retrieve the API password again. If you accidentally created the API without noting it down the password somewhere just re-start the above steps to make a new one.
🧠 You only need one API for your Toggle account that can be used at all your sites that use Tevalis.
Example below of creating the API username and password:
Product ID and Account ID
You will also need to send Tevalis your Toggle product ID and Account ID along with the API.
Your in-store product ID is found on Shop > In-Store Gift
Example below:
Your Account ID is found on the account details section of your dashboard.
Example below:
Example below of the API username and password copied to our spreadsheet (linked above) which also contains other necessary Tevalis information including the Product ID and Account ID.
Step 3: Send the API, product ID and Account ID to Tevalis and ask for your site IDs
You'll need to send the API username and password you created on Step 2 along with your in-store product ID and Account ID to your Tevalis Account Manager.
Ask your Tevalis Account Manager for your site IDs during this stage too.
Please also remember to:
🔐 Password protect your file containing the API for extra security when sending it to Tevalis. Don't send the API username and password to Tevalis within the email itself - hackers can potentially get hold of that info in the future. You could password protect your file and send your Account Manager the password for it by text message or send your API details through a password manager application.
🧠 Keep your API filed saved somewhere secure on your device (e.g. a password manager) in case you ever need to refer back to it in the future.
If you're not using the spreadsheet linked above on step 2, the table below contains the info you'll need to send Tevalis to configure your tills - but please make sure the info is sent securely and not within the email.
API endpoint: | |
Username: | (add the username you create here) |
Password: | (add the password you create here) |
Merchant ref: | 17 |
Standard in-store product ID: | (find this on Shop > In-Store gift) |
Account ID: | (find this on Account Details) |
The API endpoint is always https://api.mytoggle.io/graphql and the merchant ref 17 - don't change this.
Example email to send to Tevalis:
Step 4: Add site IDs to Toggle
Whilst your Tevalis Account Manager configures your tills using your API details, add the site IDs they sent you to your Toggle account.
Log in to Toggle
On the sidebar click Settings > Integrations > Tevalis
Paste in each ID to their respective site
Save
The site IDs allow the Tevalis and Toggle system to know where a gift card was sold or redeemed at. Without these IDs in Toggle your integration won't work.
Example below of adding the site IDs to Toggle:
Step 5: Test the integration works
Once your Tevalis Account Manager has confirmed they've configured your tills it's good to check vouchers do work.
We recommend you:
Send yourself a free of charge digital voucher
Use the voucher code on the till to see if it works (e.g. redeem/reverse, and check balance)
🧠 Other people on your team may benefit from seeing how gift vouchers works during this stage.
❗If an error is flagged on the till, get in touch with Toggle and Tevalis so we can help troubleshoot it.
Our other guide Using Toggle on Tevalis POS may also be useful.