{"_id":"543db19f31ca981a00a70053","parentDoc":null,"user":"542998207a6b690800768069","category":{"_id":"542998547a6b690800768072","version":"542998547a6b690800768071","pages":["542a3de5e677b0080050898f","544e8298de6bac1000236fe9","542998547a6b690800768074","542ab90154d88d140075fbd4","5433300867f20a080097a04b","5433302067f20a080097a04d","544e7ae6de6bac1000236fb5","54330b4990d63b1c0030c129","543da24b31ca981a00a6ffe7","54333238a807e208003e72d2","544e8305bd51b9080037f9cb","54332b234aeeef0800410a73","5433306067f20a080097a051","543db19f31ca981a00a70053","543d31d6a10ab32000b3aa70","54a1f0af50465f1f00bfa3e8","54cfc5925ff7e617002bbda5","54f4f09158e9df0d00917b3e"],"project":"542998547a6b69080076806e","__v":22,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-29T17:35:16.267Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"project":"542998547a6b69080076806e","version":{"_id":"542998547a6b690800768071","__v":9,"project":"542998547a6b69080076806e","createdAt":"2014-09-29T17:35:16.249Z","releaseDate":"2014-09-29T17:35:16.249Z","categories":["542998547a6b690800768072","5433027990d63b1c0030c0f1","5433028190d63b1c0030c0f2","5433028d9a2b451a00ad4508","5433055790d63b1c0030c10a","5461417d37e5bc200049e1e4","54624066ddd31b0800a58db4","54625de66d1f1010002f3901","54d309955616470d0013cc55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":9,"is_link":false,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-14T23:28:31.674Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"try":true,"basic_auth":false,"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":12,"body":"The `uid` values that you pass us are very important, whether it's in the URL of an iframe or in the arguments of a mobile SDK.  If they are used wrong, either your users will not be able to receive their points, or our fraud-control systems will not be able to watch for patterns.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"UIDs must be consistent for each user\",\n  \"body\": \"Every time you contact us about a user, or send a user to our SDK or iFrame, it is critical that the uid be the same for that visitor.  \\n\\n__Do not use__ a session id, a cookie id, or a transaction id.  If you do that, we will not recognize the user when they return.\\n\\n__The best values__ are ones that do not change for that user - your internal user ID (eg. the number that corresponds to them in your `users` database table), or their email address or username.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"What am I allowed to send as a uid?\",\n  \"body\": \"`uid` fields can be numbers (`1234556`) or strings (`james:::at:::bond.com`).  If you are using strings, please make sure you [URI / URL-encode](http://www.w3schools.com/tags/ref_urlencode.asp) them to ensure they don't get broken by a browser or library.\\n\\nIf you are using an integer value for your `uid` field, please note that the maximum allowable value is `18446744073709551615`. If you wish to use larger values for your `uid` field, you should check the Alphanumeric UID option in your app settings (see below).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"IMPORTANT: Alphanumeric UIDs\",\n  \"body\": \"We are rolling out a change to our system shortly that will allow all apps to use alphanumeric strings for uids, but right now if you want to do this, you need to check this option in your App Settings. See below:\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ThbGuCQMTTaqzQTd1R5U_Screenshot%201:6:15,%201:29%20PM.png\",\n        \"Screenshot 1:6:15, 1:29 PM.png\",\n        \"727\",\n        \"323\",\n        \"#c93365\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Suggestions to make user transactions work best.","slug":"notes-on-uids","type":"basic","title":"Notes on UIDs"}

Notes on UIDs

Suggestions to make user transactions work best.

The `uid` values that you pass us are very important, whether it's in the URL of an iframe or in the arguments of a mobile SDK. If they are used wrong, either your users will not be able to receive their points, or our fraud-control systems will not be able to watch for patterns. [block:callout] { "type": "warning", "title": "UIDs must be consistent for each user", "body": "Every time you contact us about a user, or send a user to our SDK or iFrame, it is critical that the uid be the same for that visitor. \n\n__Do not use__ a session id, a cookie id, or a transaction id. If you do that, we will not recognize the user when they return.\n\n__The best values__ are ones that do not change for that user - your internal user ID (eg. the number that corresponds to them in your `users` database table), or their email address or username." } [/block] [block:callout] { "type": "success", "title": "What am I allowed to send as a uid?", "body": "`uid` fields can be numbers (`1234556`) or strings (`james@bond.com`). If you are using strings, please make sure you [URI / URL-encode](http://www.w3schools.com/tags/ref_urlencode.asp) them to ensure they don't get broken by a browser or library.\n\nIf you are using an integer value for your `uid` field, please note that the maximum allowable value is `18446744073709551615`. If you wish to use larger values for your `uid` field, you should check the Alphanumeric UID option in your app settings (see below)." } [/block] [block:callout] { "type": "danger", "title": "IMPORTANT: Alphanumeric UIDs", "body": "We are rolling out a change to our system shortly that will allow all apps to use alphanumeric strings for uids, but right now if you want to do this, you need to check this option in your App Settings. See below:" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/ThbGuCQMTTaqzQTd1R5U_Screenshot%201:6:15,%201:29%20PM.png", "Screenshot 1:6:15, 1:29 PM.png", "727", "323", "#c93365", "" ] } ] } [/block]