{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b7996912-fccb-4091-8821-89e464400101","name":"Guper","description":"Guper is a powerful tool developed based on the MACH architecture (Microservices, API-first, Cloud-native, and Headless), with its main goal being to drive customer revenue. This platform offers various functionalities, such as Loyalty, which encourages customer loyalty by offering cashback as an incentive for future purchases in the store. Additionally, Analytics is an indispensable tool that analyzes store order data and provides valuable insights and strategic suggestions to optimize sales and promote more effective campaigns. With Guper, companies gain access to essential resources to boost financial returns and enhance their business strategies.\n\n## Integration landscape\n\n**POS & Ecommece**\n\nAll POS and Ecommerce integrations communicate with the **Integration API**, specifically through the [Checkout API](https://developers.guper.co/#b461d9b5-6eb3-453d-af64-de19198abeac), to transmit shopping data to the **Guper Engine**.\n\nThe **Guper Engine** is the core component responsible for evaluating and applying all promotion and reward rules. It processes this data in real time, ensuring that the appropriate benefits—such as discounts, cashback, or loyalty points—are applied seamlessly during both **navigation** and **checkout**.\n\nWhen data is received, the Guper Engine determines which rules are eligible based on the configured conditions. For each rule that is triggered, it returns the corresponding **effect(s)** to the integration layer, enabling an instant and smooth application of the rewards.\n\n<img src=\"https://content.pstmn.io/b9730790-1d7f-4482-8711-3ec2950705bd/SW50ZWdyYXRpb24gTGFuZHNjYXBlLmRyYXdpby5wbmc=\">\n\n**Data Transfer**\n\nThe **Data Transfer** layer is designed to keep your systems—such as CRM, BI tools, Data Lakes, or any other applications—up to date with the latest customer and order activity.\n\nWe provide two dedicated feeds: [Customer Feed](https://developers.guper.co/#ef9097be-65ac-4c08-af50-53c135a82060) and [Order Feed](https://developers.guper.co/#3b8ca0b9-d69e-437f-856c-02d001d64b8a). These feeds continuously list updates in real time. Every time a customer or order is updated, a new entry is added to the respective feed.\n\nUpdates may include:\n\n- New customer or order registration\n    \n- Profile or status changes\n    \n- Items added or removed from an order\n    \n- Tags or audiences added or removed\n    \n- Rewards or promotions applied or revoked\n    \n- And more\n    \n\nThis setup ensures a seamless data flow for enriched analytics, reporting, and customer engagement strategies.\n\n<img src=\"https://content.pstmn.io/ae8e9afb-9c24-4aac-bdc1-df8fd4fe599f/RmVlZC5wbmc=\">\n\n## Authentication\n\nThe **authorization token** is extremely necessary to make any requests to APIs in Guper.\n\nAuthentication for Guper APIs is performed through our **Authorization Token**. This token must be included in nearly all requests, utilizing the '_x-guper-authorization_' header.\n\nThe generation of this token is carried out via a dedicated endpoint, using the API key (_x-guper-apikey_) and API secret (_x-guper-apisecret_). These credentials are established during the configuration of an API access account, with the initial set being generated by the Guper integration team.\n\n### 503 response\n\nAn HTTP 500 response from our servers is some internal API malfunction. If the outage persists or you receive any other form of HTTP _5XX_ error, contact support.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1022797","team":5165323,"collectionId":"b7996912-fccb-4091-8821-89e464400101","publishedId":"2s93m5zh2u","public":true,"publicUrl":"https://developers.guper.co","privateUrl":"https://go.postman.co/documentation/1022797-b7996912-fccb-4091-8821-89e464400101","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentation for using the Guper API"},{"name":"title","value":" Guper API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2023-08-09T17:15:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":" Guper API Documentation","description":"Documentation for using the Guper API"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Guper","id":"fd77f78b-1319-454f-9ddd-d2b2225209ed","owner":"1022797","values":[{"key":"scheme","value":"https","enabled":true,"type":"default"},{"key":"account","value":"acme","enabled":true,"type":"default"},{"key":"environment","value":"myguper.com","enabled":true,"type":"default"},{"key":"apiKey","value":"","enabled":true,"type":"default"},{"key":"apiSecret","value":"","enabled":true,"type":"secret"},{"key":"token","value":"","enabled":true,"type":"secret"},{"key":"confirmToken","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f2066970a70925edbde1ea019aa7fae2a72115fe66b357e5a14381f6b5fe1f66","favicon":"https://res.cloudinary.com/postman/image/upload/v1724760654/team/bf082719ebc42c9d6e7629d339080af8.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Guper","value":"1022797-fd77f78b-1319-454f-9ddd-d2b2225209ed"}],"canonicalUrl":"https://developers.guper.co/view/metadata/2s93m5zh2u"}