Access is restricted to whitelisted IP addresses only.
\nEach request will require basic 'Authorization' header to be present.
\nSyntax
\nAuthorization: <type\\> <credentials\\>
Directives
\n<type\\>\n Authentication type. In this case 'Basic'.
<credentials\\>\n The credentials are constructed like this:
The username and the password are combined with a colon (client_id:client_secret).\n The resulting string is base64 encoded (Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=).\nExample header\nAuthorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=
| **error_code** | \n**detail** | \n**notes** | \n
| 4000 | \nfield errors | \nIndicates an input parameter error. Details provided in the `fields` dictionary. | \n
| 4001 | \nThe code is not valid. | \nThe code is not a valid code. | \n
| 4002 | \nThe code has already been used. | \nThis code has already been redeemed by a user. | \n
| 4003 | \nThis prize has already been redeemed. | \nThis code has already been redeemed by a user. | \n
| 4004 | \nThe prize has expired. | \nThis prize has been redeemed and has now expired. | \n
| 4005 | \nThe prize was not found. | \nThe prize with the requested id was not found. | \n
| 4006 | \nThe prize has already been claimed. | \nThe prize has already been claimed. | \n
| 4007 | \nThe prize does not belong to this user. | \nThe user id sent to claim does not match the one used at time of redemption. | \n
| 4008 | \nThe prize has not yet been redeemed. | \nPrizes must be first redeemed before they can be claimed. | \n
| 4009 | \nThere was a problem redeeming your prize, please try again later. | \nThis error could occur when two users try to redeem the same prize at the same time. | \n
| 4010 | \nThe limit of 15 unclaimed prizes has been reached. | \nThe user must claim some of their unclaimed prizes in order to redeem any more prizes. | \n
Typical user journey would start with a code.
\ndraw enpoint. A prize is returned if code is valid.redeem endpoint. User is awared the prize and expire time starts.claim endpoint to claim the prize.Alternatively for minor prizes they have redeemed a code previously and have not claimed their minor prize.
\ninbox endpoint.claim endpoint to start the timed burn process.Alternatively for major prizes they have redeemed a code previously and have not claimed their major prize.
\ninbox endpoint.claim endpoint to claim the major prize.Get all prizes that a user has redeemed.
\n** NOTE: ** unix timestamps are in UTC
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"Draw a prize with a code.
\nThis endpoint will allocate a prize to a code.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"Redeem a prize and assign it to the specified user.
\n** NOTE: ** unix timestamps are in UTC
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"Claim a prize.
\nNOTE:
\nCheck the status of a code without performing any actions.
\n** NOTE: ** unix timestamps are in UTC
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"Get the list of prize types and their ids for the promotion.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"Simple API health check endpoint.
\n","urlObject":{"path":["health"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ffb3ba38-4d64-445b-a968-09263247107f","name":"health","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/health"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Allow","value":"GET, HEAD, OPTIONS","name":"Allow","description":"Valid actions for a specified resource. To be used for a 405 Method not allowed"},{"key":"Content-Length","value":"4","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 15 Aug 2018 11:28:50 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.6.5","name":"Server","description":"A name for the server"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"}],"cookie":[{"expires":"Thu Aug 08 2019 02:29:12 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"ysizC72sj5Gr0Uxpv3CjthB8vZFlwEXLdtVqeT7docuaOS6CttcJ6Iw0SCwqq65v","key":"csrftoken"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"\"6874acaac288027702c7accb798649ef7880ee1b$[[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05420\\054\\\"Confirmation e-mail sent to mr.babic@gmail.com.\\\"]\\054[\\\"__json_message\\\"\\0540\\05425\\054\\\"Successfully signed in as mr.babic@gmail.com.\\\"]\\054\\\"__messagesnotfinished__\\\"]\"","key":"messages"}],"responseTime":null,"body":"\"OK\""}],"_postman_id":"d8257a5f-f192-4361-af7e-155de55a4b4d"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":"