XcelDataAPI:Rewards

From XcelData Wiki
Revision as of 18:02, 24 April 2018 by Charliej (talk | contribs) (Created page with "{{InDev}} =URL Structures= <nowiki>https://api.xceldata.com/0.1/pawn2me/rewards/[add|redeem]/[output-format]/[drivers-id]/[transaction-no]/[points]/[apikey]</nowiki> <nowik...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This article documents features that are still in development.

Information may change rapidly as the event progresses, or if requirements change. The last updates to this article may not reflect the most current information.


URL Structures

https://api.xceldata.com/0.1/pawn2me/rewards/[add|redeem]/[output-format]/[drivers-id]/[transaction-no]/[points]/[apikey]

https://api.xceldata.com/0.1/pawn2me/rewards/view/[output-format]/[drivers-id]/[transaction-no]/[apikey]

URL Variable Breakdown

output-format

string: xml or json

Specifies XML or JSON output.

add, redeem and view

string: add, redeem or view

Used to denote which function to execute.

drivers-id

string: a valid drivers license id

Used to find activated customers in the pawn2me database (with matching api key).

transaction-no

string: a unique transaction number

The add-pointsendpoint will not apply points-earned more than once for the same transaction-no.

points

int: points

Will add or subtract this many points to the users bucket.

api-key

string: a valid store api key

Store API keys can be obtained from app.xceldata.com/customers

Example of successful response (using dev store api key)

soon!