Difference between revisions of "XcelDataAPI:Home"

From XcelData Wiki
Jump to: navigation, search
(Created page with "{{InDev}} =URL Structure= <nowiki>https://api.xceldata.com/0.1/metal-feed/[output-format]/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]/[apikey]</nowiki> ==URL Va...")
 
(test)
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{InDev}}
 
{{InDev}}
  
=URL Structure=
+
=XcelData API=
 +
XDAPI provides a collection of web services shared by various XcelData products.
  
<nowiki>https://api.xceldata.com/0.1/metal-feed/[output-format]/[unit-type]/[loan-percent]/[buy-percent]/[sell-percent]/[apikey]</nowiki>
+
The number of services depends on the version your products use. Old versions will be deprecated over time and will become unavailable.
  
==URL Variable Breakdown==
+
{|class="wikitable"
===output-format===
+
|-
''string: xml or json''
+
! Feature / Version
 +
! [[XcelDataAPI:Version_0.1|0.1]]
 +
! [[XcelDataAPI:Version_0.2|0.2]]
 +
|-
 +
| Metal Feeds
 +
| {{checkmark}}
 +
| {{checkmark}}
 +
|-
 +
| Cloud Support
 +
| {{crossmark}}
 +
| {{checkmark}}
 +
|-
 +
| Rewards Points
 +
| {{crossmark}}
 +
| {{checkmark}}
 +
|-
 +
| Address Standardization
 +
| {{crossmark}}
 +
| {{checkmark}}
 +
|}
  
Specifies XML or JSON output.
+
== Versions ==
 +
* [[XcelDataAPI:Version_0.1|XcelData API v0.1]] - Current
 +
* [[XcelDataAPI:Version_0.2|XcelData API v0.2]] - InDev
 +
* [[XcelDataAPI:Version_0.3|XcelData API v0.3]] - Planned
  
===unit-type===
+
==Support Topics==
''string: dwt or gr''
+
* Specially Designated Nationals: [[Support:SDN|How to determine a SDN "hit"]]
  
Specifies Pennyweight or Grams
+
[[Category:XcelDataAPI]]
 
 
===loan-percent, buy-percent and sell-percent===
 
''integer or decimal: range between 0 and 100''
 
 
 
Specifies the adjustments that will be shown to tellers.
 
 
 
===api-key===
 
''string: a valid store api key''
 
 
 
Store API keys can bet obtained from [https://app.xceldata.com/ app.xceldata.com]
 
 
 
 
 
==Example of good feeds (using dev store api key)==
 
[https://api.xceldata.com/0.1/metal-feed/xml/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93 https://api.xceldata.com/0.1/metal-feed/xml/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93]
 
 
 
[https://api.xceldata.com/0.1/metal-feed/xml/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93 https://api.xceldata.com/0.1/metal-feed/xml/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93]
 
 
 
[https://api.xceldata.com/0.1/metal-feed/json/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93 https://api.xceldata.com/0.1/metal-feed/json/dwt/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93]
 
 
 
[https://api.xceldata.com/0.1/metal-feed/json/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93 https://api.xceldata.com/0.1/metal-feed/json/gr/60/80/150/1E17162A-8355-4FF2-8DCD-E5CEE676FD93]
 

Latest revision as of 17:21, 18 July 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.


XcelData API

XDAPI provides a collection of web services shared by various XcelData products.

The number of services depends on the version your products use. Old versions will be deprecated over time and will become unavailable.

Feature / Version 0.1 0.2
Metal Feeds
Cloud Support
Rewards Points
Address Standardization

Versions

Support Topics