{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"17849a4f-c373-4720-812a-3d3e9914313e","name":"NextBee API V3.3","description":"---\n\nNextBee delivers best in class SAAS solution to drive user loyalty, gamification and advocacy through it's cloud hosted platform. Use the index on the right panel to navigate through our dev portal and view sample code and language preference on the right panel. If you have any questions, please feel free to contact our support team directly at [support@nextbee.com](https://mailto:support@nextbee.com).\n\n# Overview\n\nNextBee's Platform can be integrated with many environments and programming languages via our web API. Check out this document for an introduction to the wrappers and available code samples.\n\n# Getting Started\n\nGetting started with NextBee APIs is simple and secure. As soon as you create an account with the assistance of your account manager, you need to follow these 3 simple steps to get started!\n\n1. Get your Authentication Key so we can authenticate your requests.\n    \n2. Install the SDKs and select your API Endpoints.\n    \n3. Test your new connection to validate.\n    \n\n# Authentication\n\nAll requests to the NextBee API must include the following HTTP Headers. These are used to validate the request and to verify that the data has not been compromised.\n\n| Header | Type | Value |\n| --- | --- | --- |\n| ts-key | Timestamp | Timestamp in milliseconds from the epoch time |\n| api-call-signature | String | The Encrypted value is calculated md5 hash of client’s api auth key followed by pass_code then followed by the “ts-key” value used that is sent in Request header md5(api-auth-key + pass-code + ts-key + request-url) |\n| ekey | String | \\[optional\\] Required in user specific APIs only. Encrypted value is calculated as md5 hash of lower case of the user email followed by the pass_code. md5(lower_case_email + pass-code) |\n\nNote:\n\n> api-auth-key: `Main authorization key of the client` \n  \n\n- Client Id, Program Id, Widget Ids will be shared by NextBee\n    \n\n# NextBee Architecture Diagram\n\n<img src=\"https://businessacount.nextbee.com/static-images/architecture-diagram.png\" alt=\"alt text\">\n\n# Data Connectors\n\n### CRM/ERP/POS Connectors\n\nNextBee readily integrates with most major systems such as SalesForce, NetSuite, Microsoft Dynamics among many others for seamless two way data transfer.\n\n### SFTP File\n\nOn a preset frequency (hourly, daily, monthly, etc.) can set-up an automated data file upload to SFTP. This could be standard transaction report from any system and our team will create a custom parser to process the data.\n\n### Read Only Access\n\nProvide read only access to specific fields within SF or to your database and NextBee can extract the required data on a set frequency.\n\n### API Push\n\nDirectly integrate with in-house systems via APIs to receive data in near real time for any transaction.\n\n### Multiple Data Feeds\n\nNextBee can ingest and process multiple data feeds and consolidate transactions to the same user profile using multiple unique identifiers.\n\n### Pixel Tracking\n\nAny transactions made online can be tracked with a simple pixel implementation\n\n# Sample Data Schema\n\n| Attribute | Application for Client Prorgram | Does it Change | Client Name | Method of Transmission | Type of File | Frequency of Update | Expected Number of Records Per Batch |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n|  |  |  |  |  |  |  |  |\n| Name |  |  |  |  |  |  |  |\n| Organization |  |  |  |  |  |  |  |\n| User Type |  |  |  |  |  |  |  |\n| Email |  |  |  |  |  |  |  |\n| Unique System ID |  |  |  |  |  |  |  |\n| Status |  |  |  |  |  |  |  |\n| Location |  |  |  |  |  |  |  |\n| Division |  |  |  |  |  |  |  |\n| Role |  |  |  |  |  |  |  |\n| Segment |  |  |  |  |  |  |  |\n| Communication Preference |  |  |  |  |  |  |  |\n| Manager |  |  |  |  |  |  |  |\n| Tenure |  |  |  |  |  |  |  |\n|  |  |  |  |  |  |  |  |\n|  |  |  |  |  |  |  |  |\n| TRANSACTION ATTRIBUTES |  |  |  |  |  |  |  |\n| Attribute | Application for Client Prorgram | Does it Change | Client Name | Method of Transmission | Type of File | Frequency of Update | Expected Number of Records Per Batch |\n|  |  |  |  |  |  |  |  |\n| Transaction ID |  |  |  |  |  |  |  |\n| Date |  |  |  |  |  |  |  |\n| Type |  |  |  |  |  |  |  |\n| Numeric Value |  |  |  |  |  |  |  |\n| Discount |  |  |  |  |  |  |  |\n| Currency |  |  |  |  |  |  |  |\n| Product |  |  |  |  |  |  |  |\n| Product Category |  |  |  |  |  |  |  |\n| Brand |  |  |  |  |  |  |  |\n| Bonus Critieria |  |  |  |  |  |  |  |\n| SKU |  |  |  |  |  |  |  |\n| Status |  |  |  |  |  |  |  |\n| Location |  |  |  |  |  |  |  |\n| Channel |  |  |  |  |  |  |  |\n|  |  |  |  |  |  |  |  |\n|  |  |  |  |  |  |  |  |\n| TRIGGERED ACTIVITY ATTRIBUTES |  |  |  |  |  |  |  |\n| Attribute | Application for Client Prorgram | Does it Change | Client Name | Method of Transmission | Type of File | Frequency of Update | Expected Number of Records Per Batch |\n|  |  |  |  |  |  |  |  |\n| New Badge Earned |  |  |  |  |  |  |  |\n| New Rewards Earned |  |  |  |  |  |  |  |\n| New Points Earned |  |  |  |  |  |  |  |\n| New Level Up Status |  |  |  |  |  |  |  |\n| New Activity Completed |  |  |  |  |  |  |  |\n| Activity Statue Update |  |  |  |  |  |  |  |\n| Leaderboard Rank Update |  |  |  |  |  |  |  |\n\n# Data Flow Diagrams\n\nOur Platform is built based on a set of configurable micro-services that can be readily integrated in our clients’ IT systems to deliver an optimized engagement program for employees, partners, and customers of our clients. The following block diagram lists the key modules.\n\n## CRM Registration Flow\n\n<img src=\"https://businessacount.nextbee.com/static-images/CRM_Registrationflow.png\" alt=\"alt text\">\n\n## SSO FLow\n\n<img src=\"https://businessacount.nextbee.com/static-images/SSOflowiFrameusingJWT.png\" alt=\"alt text\">\n\n## Referral Flow\n\n<img src=\"https://businessacount.nextbee.com/static-images/referralflow.png\" alt=\"alt text\">\n\n## Activity Flow\n\n<img src=\"https://businessacount.nextbee.com/static-images/activityFlow.png\" alt=\"alt text\">\n\n# Whitelist IP Addresses\n\nWe offer the possibility to whitelist your IP addresses which means, that only the addresses you send us will be able to send requests to our API endpoints or log in to our UI.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7842014","team":404600,"collectionId":"17849a4f-c373-4720-812a-3d3e9914313e","publishedId":"SW11XeGk","public":true,"publicUrl":"https://apidocs.nextbee.com","privateUrl":"https://go.postman.co/documentation/7842014-17849a4f-c373-4720-812a-3d3e9914313e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"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.1","publishDate":"2024-08-12T06:41:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"95cb0236-6339-417f-aa53-059475fdd6d7","owner":"7842014","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"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/2eb14cedebc6ab2dc283f18550c7984a8dda541853a9a7a7ac6c508c2c75d058","favicon":"https://nextbee.com/favicon.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":"Production","value":"7842014-95cb0236-6339-417f-aa53-059475fdd6d7"}],"canonicalUrl":"https://apidocs.nextbee.com/view/metadata/SW11XeGk"}