This API allows an external app to remotely send actions to the Fidely-Box that are normally done using the keyboard provided with the Fidely-Box.
\nIf you are integrating this API in a cash register solution, you will most likely only need the \"Visit\", \"Tracking\", and maybe \"Cancel\" endpoints. You might also want to receive a callback from the Fidely-Box when a customer completes a visit, in order to automatically apply a discount when they complete their loyalty card. To do this, follow the documentation in the \"FidRemote_CallbackDoc\" file.
\nIn order to use this API, you need a \"FidRemote\" token which indentifies your Fidely-Box and its loyalty card. If your Fidely-Box has multiple loyalty cards, you will need one token for each card. If you have multiple points of sale, each with a Fidely-Box, you will need different tokens for each Fidely-Box.
\nContact us if you don't have your FidRemote tokens yet.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"}],"owner":"34892849","collectionId":"3c29111a-23d1-4be5-8330-9ab721c29d7f","publishedId":"2sA3kVn2Qv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"E7565D"},"publishDate":"2024-07-31T13:42:34.000Z"},"item":[{"name":"Visit","id":"8983f570-67aa-4991-85b6-19b9fb1e2433","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR-FIDREMOTE-TOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Amount\": 15\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apifb.athyla.be/v2/FidRemote/Visit","description":"Unlocks the keyboard on the Fidely-Box's screen so the customer can enter their mobile number and add a visit to their loyalty card.
\nAfter the customer confirms their mobile number and the visit is created, the Fidely-Box will send data that can be retrieved containing the advancement of the customer's loyalty card and the discount the customer is entitled to, if any. If you want to retrieve this data and implement it in your solution, read the documentation in the \"FidRemote_CallbackDoc\" file.
\nThe request can take two optional parameters:
\namount: double : the total price of the customer's purchases OR the amount of points to add to the customer's loyalty card, depending on your loyalty card's modality. Cannot be less than 0. The default value is 0 if no amount is provided
quantity: int : the amount of points to add to the customer's loyalty card, only if it is a card that works with points. If no quantity is provided, \"amount\" will be used instead as points. The amount will be automatically converted into the right amount of points, if the Fidely-Box is configured that way. Otherwise, an amount of 1 translates to 1 point. Quantity cannot be less than 0
Show available promotional offers of the Fidely-Box. The customer then picks one and enters their mobile number and any other eventual information the promotional offer requires.
\nUpon activation of a promotional offer, the Fidely-Box will send data that can be retrieved containing the discount the customer is entitled to. If you want to retrieve this data and implement it in your solution, read the documentation in the \"FidRemote_CallbackDoc\" file.
\nThe request takes one optional parameter:
\namount: double : the total price of the customer's purchases. Cannot be less than 0. The default value is 0 if no value is provided, but if the customer picks a promotional offer that requires the total price of their purchases, then the merchant will have to manually enter the amount on the Fidely-BoxReturn the Fidely-Box to its initial state.
For example, if the \"Visit\" endpoint was previously called to unlock the Fidely-Box for a customer to enter their mobile number, but the customer refused to do so, you might want to return the Fidely-Box to its initial state so another customer won't enter their mobile number for the wrong visit
Show the last confirmation message on the Fidely-Box's screen again
\n","urlObject":{"protocol":"https","path":["v2","FidRemote","LastMessage"],"host":["apifb","athyla","be"],"query":[],"variable":[]}},"response":[],"_postman_id":"17685f10-0506-4068-895b-b7e46ebd517f"},{"name":"Form","id":"6dcec9e3-a881-4bb4-9820-fe6658f94e16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR-FIDREMOTE-TOKEN","type":"text"}],"url":"https://apifb.athyla.be/v2/FidRemote/Form","description":"Unlocks the keyboard on the Fidely-Box's screen so the customer can enter their mobile number and be sent to the contact form
\n","urlObject":{"protocol":"https","path":["v2","FidRemote","Form"],"host":["apifb","athyla","be"],"query":[],"variable":[]}},"response":[],"_postman_id":"6dcec9e3-a881-4bb4-9820-fe6658f94e16"},{"name":"LastVisits","id":"cf6f6cf0-4d63-40de-9353-58d6c762bfab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR-FIDREMOTE-TOKEN","type":"text"}],"url":"https://apifb.athyla.be/v2/FidRemote/LastVisits","description":"Shows the last 3 visits on the Fidely-Box so the merchant can pick one to delete
\n","urlObject":{"protocol":"https","path":["v2","FidRemote","LastVisits"],"host":["apifb","athyla","be"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf6f6cf0-4d63-40de-9353-58d6c762bfab"},{"name":"Status","id":"65e6735e-4d93-414c-b13b-e757c1073412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR-FIDREMOTE-TOKEN","type":"text"}],"url":"https://apifb.athyla.be/v2/FidRemote/Status","description":"Unlocks the keyboard on the Fidely-Box's screen so the customer can enter their mobile number and check their loyalty card's status
\n","urlObject":{"protocol":"https","path":["v2","FidRemote","Status"],"host":["apifb","athyla","be"],"query":[],"variable":[]}},"response":[],"_postman_id":"65e6735e-4d93-414c-b13b-e757c1073412"},{"name":"ChangeMobile","id":"5ac5a219-2fdd-47a2-9fc3-f853afd126eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer YOUR-FIDREMOTE-TOKEN","type":"text"}],"url":"https://apifb.athyla.be/v2/FidRemote/ChangeMobile","description":"Unlocks the keyboard on the Fidely-Box's screen so the customer can enter their old mobile number and change it to their new one
\n","urlObject":{"protocol":"https","path":["v2","FidRemote","ChangeMobile"],"host":["apifb","athyla","be"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ac5a219-2fdd-47a2-9fc3-f853afd126eb"}],"event":[{"listen":"prerequest","script":{"id":"668f1d60-5673-4ab7-98bb-8b6a773f00d1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"38590e4c-3812-4bcc-89e4-b4594f1f7117","type":"text/javascript","packages":{},"exec":[""]}}]}