{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7a685458-c46b-4a98-85eb-c7cb4fec0805","name":"Coniq APIs","description":"Coniq offers a suite of APIs that provide machine-machine access to many aspects of our platform and services. All API integrations should be registered with Coniq, so that we can generate and provide you with the credentials you need to issue API requests. Please do contact your account manager to discuss your needs and we will be able to provide you with guidance on the best implementations.\n\nThis page provides high level details of the different major groups of functionality assocaited within our API:\n\n- Authentication - overview of Coniq's authentication practices for all API\n    \n- Platform API suite - Server side specific API\n    \n- Client Side API - Customer facing user interface API\n    \n- Open signup API - customer signup API for wide use\n    \n\n# Authentication\n\n### [Authentication](https://documenter.getpostman.com/view/6954014/SWTG5F43?version=latest)\n\n- An overview of the different forms of Authentication required by our APIs and how they should be implemented.\n    \n\n# Platform API\n\n### [Platform API 2.0 Overview](https://documenter.getpostman.com/view/4580793/RWEgqyXv)\n\n- This is a set of APIs available for **server side interaction** with Coniq held data:\n    \n\n### [Barcode API 2.0](https://documenter.getpostman.com/view/4580793/RWEjnwt9)\n\n- This API allows clients to generate and retrieve barcodes programmatically. Barcodes are not directly accessible through the platform user interface but represent the link between a Customer and an Offer/Reward that can be redeemed for specific types of Coniq program.\n    \n\n### [Offer API 2.0](https://documenter.getpostman.com/view/4580793/RWEgqyY3)\n\n- This API will allow clients to manage Offers and Loyalty Programs programmatically.\n    \n- GET functionality does not support linked offers as these are assigned at subscription level.\n    \n\n### [Customer API 2.0](https://documenter.getpostman.com/view/4580793/RWEgqyXx)\n\n- This API allows clients to manage customer data programmatically with the standard create, retrieve, update, and delete methods. Clients are also able to retrieve customer records in batch, by update date.\n    \n\n### [Subscription API 2.0](https://documenter.getpostman.com/view/10758010/UyxnEk7L)\n\n- The relationship between a customer and a loyalty program is referred to as a subscription.\n    \n- This API allows Clients to query the relationship between a customer and a loyalty program offer. They are able to see if a customer is part of a loyalty program or has been sent an offer or reward. They can determine a customer’s expiry date from a program or membership and can update this date on renewal.\n    \n- This API also allows the assigning of a reward to a customers program subscription.\n    \n- This API can update a customers tier allocation, for programs which do not utilise Coniq points engine.\n    \n\n### [Locations API 2.0](https://documenter.getpostman.com/view/4580793/RWEjqHeN)\n\n- This API allows clients to manage Locations programmatically. In the platform, Locations are referred to as Places.\n    \n\n### [Linked offers API 2.0](https://documenter.getpostman.com/view/4580793/RWEiKdZd)\n\n- This API allows for the assigning of an offer to a customer’s loyalty program subscription.\n    \n- This would be in addition to offers/rewards a customer already has access to by being part of a loyalty program.\n    \n\n### [Tax Free API 2.0](https://documenter.getpostman.com/view/4580793/RWaNQmhm)\n\n- This document describes the functionality available in version 2.0 of the Tax Free API.\n    \n\n### [Data API 2.0](https://documenter.getpostman.com/view/4063684/RWgnWKpK)\n\n- This API allows information about transactions to be queried for an account.\n    \n\n### [Signups API 2.0](https://documenter.getpostman.com/view/3416044/2s93JowQsy)\n\n- This API allows information about signups to be queried for an account.\n    \n\n### [External Transactions API 2.0](https://documenter.getpostman.com/view/4063684/RWgp2zZy)\n\n- Endpoints that allow transactions to be recorded against a valid Coniq account that come from an external source - for example, transactions that are generated by an eCommerce platform or an external app. Specifically, these are transactions that do not originate from a Coniq scanner.\n    \n\n### [Policy API 1.0](https://documenter.getpostman.com/view/4580793/RWEiJd7s)\n\n- A set of methods for interrogating the policy documentation associated with accounts.\n    \n\n### [Communication API 2.0](https://documenter.getpostman.com/view/10758010/2s93XyVj6C)\n\n- This document describes the functionality available in version 2.0 of the Communication API.\n    \n\n### [Data Capture (Location Report) API 2.0](https://documenter.getpostman.com/view/49940496/2sB3Wtrdjd)\n\n- This document describes the functionality available for the data capture questions and answers.\n    \n\n# Client Side API\n\n### [Client Side App API 3.0](https://documenter.getpostman.com/view/4580793/RWEiKy3b)\n\n- This API provides functionality to support **customer mobile apps and website**; it is centered around populating a client's app with offer/reward, customer details (including tiers and points) and location information. The API allows customers to interact with their loyalty program.\n    \n- The API also supports a number of other Coniq functionalties including receipt scanning, card linking, subscription payment and referral programs.\n    \n- **EXTERNAL EVENTS API** - The Client Side App API also has the functionality to allow the awarding of points to customers for carrying out events in 3rd party system\n    \n\n# OPEN SIGNUP API\n\n### [Open Signup API 2.0](https://documenter.getpostman.com/view/6954014/SWTG5vF8?version=latest)\n\n- Sign-up forms can be created within the platform to collect customer information and respond with some business logic. They are used to sign-up customers for a newsletter, sign-up customers for an offer, register a loyalty card, or send an email with requested information.\n    \n- This API allows clients to programmatically retrieve and submit sign-up forms and can be used to customise the sign-up form customer experience or more easily integrate with other systems. It is designed to mirror the functionality of the web sign-up forms.\n    \n- This API is used to sign up customers to an app based loyalty program, generating a unique customer identifier.\n    \n\n# Receipt Scanning API\n\n### [Receipt Scanning API 2.0](https://documenter.getpostman.com/view/3416044/2s84LLws2p)\n\n- Submit receipts to Coniq's receipt scanning feature\n    \n\n# Notes\n\nConiq have a suite of webhooks which can be shared on request.\n\n## Terminology\n\n- Reward program - a customer specific program which holds a customer's offers/rewards/linked offers under a single barcode identifier\n    \n- Offer - Single use, Multi use, once a day. Once used will still be returned in the offers list, but will error on scanning at a Coniq scanner.\n    \n- Reward - can be consumed, and then disappears from the offers list. Can have multiple instances of the same reward with different expiry dates. Utilised in stamp card programs.\n    \n- Linked offer - offer which can be linked to a customer's loyalty code through the use of an API.\n    \n\n## Points\n\nConiq can develop a program which rewards points to a customer based on\n\n- Redemption event, or number of redemption events\n    \n- External event, such as a parking kiosk redemption\n    \n- Timed, from redemption, relating to birthday or time from subscription to a program","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4063684","collectionId":"7a685458-c46b-4a98-85eb-c7cb4fec0805","publishedId":"RWaDWrYa","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4063684/RWaDWrYa","privateUrl":"https://go.postman.co/documentation/4063684-7a685458-c46b-4a98-85eb-c7cb4fec0805","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2018-09-03T09:34:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RWaDWrYa"}