Difference between revisions of "XcelDataAPI:Version 0.2"
(→API Endpoints) |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
== Changes == | == Changes == | ||
* New URL ordering - putting the output format and api key at the beginning standardizes the url and takes the responsibility off of each of the server side route controllers from having to handle store key variable parsing | * New URL ordering - putting the output format and api key at the beginning standardizes the url and takes the responsibility off of each of the server side route controllers from having to handle store key variable parsing | ||
| + | * New License Checking service - returns superpawn license information. | ||
| + | * New Rewards Points service - for now we are just going to start logging the information so we can see how many points are awarded daily etc, later we will add point redemption system. | ||
| + | * New Address Standardization service - Correct up to 5 addresses at a time! | ||
== Main Entrypoint == | == Main Entrypoint == | ||
| Line 17: | Line 20: | ||
|- | |- | ||
! Endpoint | ! Endpoint | ||
| + | ! Method | ||
! URL | ! URL | ||
|- | |- | ||
| Metal Feed | | Metal Feed | ||
| + | | GET | ||
| | | | ||
* /metal-feed/[[XcelData:Terms#unit-type|unit-type]]/[[XcelData:Terms#adj-loan|adj-loan]]/[[XcelData:Terms#adj-buy|adj-buy]]/[[XcelData:Terms#adj-sell|adj-sell]] | * /metal-feed/[[XcelData:Terms#unit-type|unit-type]]/[[XcelData:Terms#adj-loan|adj-loan]]/[[XcelData:Terms#adj-buy|adj-buy]]/[[XcelData:Terms#adj-sell|adj-sell]] | ||
|- | |- | ||
| License Check | | License Check | ||
| + | | GET | ||
| | | | ||
* /license-check/[[XcelData:Terms#service-name|service-name]] | * /license-check/[[XcelData:Terms#service-name|service-name]] | ||
|- | |- | ||
| Rewards Points | | Rewards Points | ||
| + | | GET | ||
| | | | ||
* /pawn2me/rewards/add-points/[[XcelData:Terms#drivers-lic|drivers-lic]]/[[XcelData:Terms#points-amt|points-amt]]/[[XcelData:Terms#transaction-id|transaction-id]] | * /pawn2me/rewards/add-points/[[XcelData:Terms#drivers-lic|drivers-lic]]/[[XcelData:Terms#points-amt|points-amt]]/[[XcelData:Terms#transaction-id|transaction-id]] | ||
* /pawn2me/rewards/view-points/[[XcelData:Terms#drivers-lic|drivers-lic]] | * /pawn2me/rewards/view-points/[[XcelData:Terms#drivers-lic|drivers-lic]] | ||
| + | * redeem and others coming soon, right now we just want to analyze the data | ||
| + | |- | ||
| + | | Address Standardization | ||
| + | | POST | ||
| + | | | ||
| + | * /standardize-address ([[XcelDataAPI:Version_0.2/standardize-address|POST Request Info]]) | ||
| + | |||
|} | |} | ||
==Example of good feeds (using dev store api key)== | ==Example of good feeds (using dev store api key)== | ||
| − | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/ | + | === Metal Feeds === |
| + | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150 https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150 https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150 https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150] | ||
[https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150 https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150] | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150 https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150] | ||
| − | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/ | + | === Rewards Program (via Pawn2ME) === |
| + | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/add-points/D1234567/12/ticket12 https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/add-points/D1234567/12/ticket12] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/view-points/D1234567 https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/view-points/D1234567] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/add-points/D1234567/12/ticket12 https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/add-points/D1234567/12/ticket12] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/view-points/D1234567 https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/pawn2me/rewards/view-points/D1234567] | ||
| + | |||
| + | === License Check === | ||
| + | [https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn] | ||
| + | |||
| + | [https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn] | ||
| + | |||
| + | === Address Standardization === | ||
| + | |||
| + | Examples for this endpoint cannot be directly linked to due to technical reasons: they require POST data to be sent along with the request. | ||
| − | [ | + | * [[XcelDataAPI:Version_0.2/standardize-address#Test|Learn how to test this endpoint]] |
[[Category:XcelDataAPI]] | [[Category:XcelDataAPI]] | ||
Latest revision as of 23:11, 30 April 2018
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.
Contents
XcelData API v0.2
The second version in the zero-dot series.
Changes
- New URL ordering - putting the output format and api key at the beginning standardizes the url and takes the responsibility off of each of the server side route controllers from having to handle store key variable parsing
- New License Checking service - returns superpawn license information.
- New Rewards Points service - for now we are just going to start logging the information so we can see how many points are awarded daily etc, later we will add point redemption system.
- New Address Standardization service - Correct up to 5 addresses at a time!
Main Entrypoint
- https://api.xceldata.com/0.2/output-format/api-key/endpoint-variables
API Endpoints
Heads up: The Metal Feeds endpoint url has changed from v0.1!
| Endpoint | Method | URL |
|---|---|---|
| Metal Feed | GET | |
| License Check | GET |
|
| Rewards Points | GET |
|
| Address Standardization | POST |
|
Example of good feeds (using dev store api key)
Metal Feeds
https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150
https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/dwt/60/80/150
https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150
https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/metal-feed/gr/60/80/150
Rewards Program (via Pawn2ME)
License Check
https://api.xceldata.com/0.2/json/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn
https://api.xceldata.com/0.2/xml/1E17162A-8355-4FF2-8DCD-E5CEE676FD93/license-check/superpawn
Address Standardization
Examples for this endpoint cannot be directly linked to due to technical reasons: they require POST data to be sent along with the request.
