API Methods

From Developer's API

(Difference between revisions)
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Something here...
+
Calling an API method is done by making a request to a method URI
  
 +
API Methods are of the form:<br>
 +
<b><nowiki>https://www.mcssl.com/API/{MerchantId}[/{TableName}[/{ItemId}][/{Command}]]</nowiki></b>
 +
 +
== Examples ==
 +
* <nowiki>https://www.mcssl.com/API/118303</nowiki>
 +
**: Returns a list of Group Level methods available to merchant 118303
 +
* <nowiki>https://www.mcssl.com/API/118303/Products</nowiki>
 +
**: Returns a list of Product related methods
 +
* <nowiki>https://www.mcssl.com/API/118303/Products/LIST</nowiki>
 +
**: Returns a list of Products
 +
* <nowiki>https://www.mcssl.com/API/118303/Products/173457882/READ </nowiki>
 +
**: Returns Product details for ProductId 173457882
 +
 +
== Method Documentation ==
 
===Clients Methods===
 
===Clients Methods===
−
:[[List Clients]]
+
:[https://www.mcssl.com/API/118303/Clients/LIST?key=0&doc=1 List Clients]
−
:[[Read Client]]
+
:[https://www.mcssl.com/API/118303/Clients/READ?key=0&doc=1 Read Client]
  
 
===Products Methods===
 
===Products Methods===
−
:[[List Products]]
+
:[https://www.mcssl.com/API/118303/Products/LIST?key=0&doc=1 List Products]
−
:[[Read Product]]
+
:[https://www.mcssl.com/API/118303/Products/READ?key=0&doc=1 Read Product]
  
 
===Orders Methods===
 
===Orders Methods===
−
:[[List Orders]]
+
:[https://www.mcssl.com/API/118303/Orders/LIST?key=0&doc=1 List Orders]
−
:[[Count Orders]]
+
:[https://www.mcssl.com/API/118303/Orders/COUNT?key=0&doc=1 Count Orders]
−
:[[Read Order]]
+
:[https://www.mcssl.com/API/118303/Orders/READ?key=0&doc=1 Read Order]
  
 
===Errors Methods===
 
===Errors Methods===
−
:[[API Error Codes]]
+
:[https://www.mcssl.com/API/118303/Errors/LIST?key=0&doc=1 API Error Codes]
  
−
===API Method Parameters Matrix===
+
===Notifications Methods===
−
{|
+
:[https://www.mcssl.com/API/118303/Notifications/TEST?key=0&doc=1 Test Notification]
 +
 
 +
== API Parameters ==
 +
 
 +
API parameters help to specify what data will be returned from the API. Parameters sent to the API are required to be in XML format as shown below. These parameters can be used in conjunction with one another where the method allows a particular parameter. At the very minimum, your merchant key is required as an API parameter when making API calls.
 +
 
 +
=== API Parameter Example ===
 +
<pre>
 +
<Request>
 +
 
 +
  <Key>asfa890sduasdf98...</Key>
 +
 
 +
  <LimitCount>15</LimitCount>
 +
 
 +
  <LimitOffset>15</LimitOffset>
 +
 
 +
</Request>
 +
</pre>
 +
 
 +
=== API Method Parameters Matrix ===
 +
:{| border="1" cellspacing="0" cellpadding="5"
 
|
 
|
 
!List Clients
 
!List Clients
Line 25: Line 59:
 
!List Errors
 
!List Errors
 
|-
 
|-
−
!Limit Count
+
!align="Left"|Key<sup>1</sup>
−
|x
+
|align="Center"|•
−
|x
+
|align="Center"|•
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|•
 
|-
 
|-
−
!Limit Offset
+
!align="Left"|Limit Count<sup>2</sup>
−
|x
+
|align="Center"|•
−
|x
+
|align="Center"|•
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|-
 
|-
 
|-
−
!Sort Column
+
!align="Left"|Limit Offset
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|•
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|-
 
|-
 
|-
−
!Sort Order
+
!align="Left"|Sort Column
−
|x
+
|align="Center"|•<sup>3</sup>
−
||-
+
|align="Center"|-
−
|x
+
|align="Center"|•<sup>4</sup>
−
||-
+
|align="Center"|-
 
|-
 
|-
−
!Limit Start Date
+
!align="Left"|Sort Order<sup>5</sup>
−
||-
+
|align="Center"|•
−
||-
+
|align="Center"|-
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|-
 
|-
 
|-
−
!Limit End Date
+
!align="Left"|Limit Start Date<sup>6</sup>
−
||-
+
|align="Center"|-
−
||-
+
|align="Center"|-
−
|x
+
|align="Center"|•
−
||-
+
|align="Center"|-
 +
|-
 +
!align="Left"|Limit End Date<sup>6</sup>
 +
|align="Center"|-
 +
|align="Center"|-
 +
|align="Center"|•
 +
|align="Center"|-
 
|}
 
|}
 +
 +
:<sup>1</sup> Required for every API call
 +
 +
:<sup>2</sup> Maximum available limit count is 100
 +
 +
:<sup>3</sup> FirstName, LastName
 +
 +
:<sup>4</sup> GrandTotal
 +
 +
:<sup>5</sup> ASC or DESC
 +
 +
:<sup>6</sup> In the format MM/dd/yyyy [HH:mm:ss]
 +
 +
== API Results ==
 +
 +
The following page show examples of results that can be returned by the API
 +
 +
[[API_Results]]

Latest revision as of 20:47, 15 May 2014

Calling an API method is done by making a request to a method URI

API Methods are of the form:
https://www.mcssl.com/API/{MerchantId}[/{TableName}[/{ItemId}][/{Command}]]

Contents

Examples

  • https://www.mcssl.com/API/118303
    • Returns a list of Group Level methods available to merchant 118303
  • https://www.mcssl.com/API/118303/Products
    • Returns a list of Product related methods
  • https://www.mcssl.com/API/118303/Products/LIST
    • Returns a list of Products
  • https://www.mcssl.com/API/118303/Products/173457882/READ
    • Returns Product details for ProductId 173457882

Method Documentation

Clients Methods

List Clients
Read Client

Products Methods

List Products
Read Product

Orders Methods

List Orders
Count Orders
Read Order

Errors Methods

API Error Codes

Notifications Methods

Test Notification

API Parameters

API parameters help to specify what data will be returned from the API. Parameters sent to the API are required to be in XML format as shown below. These parameters can be used in conjunction with one another where the method allows a particular parameter. At the very minimum, your merchant key is required as an API parameter when making API calls.

API Parameter Example 

<Request>

   <Key>asfa890sduasdf98...</Key>

   <LimitCount>15</LimitCount>

   <LimitOffset>15</LimitOffset>

</Request>

API Method Parameters Matrix

List Clients List Products List Orders List Errors
Key1 • • • •
Limit Count2 • • • -
Limit Offset • • • -
Sort Column •3 - •4 -
Sort Order5 • - • -
Limit Start Date6 - - • -
Limit End Date6 - - • -
1 Required for every API call
2 Maximum available limit count is 100
3 FirstName, LastName
4 GrandTotal
5 ASC or DESC
6 In the format MM/dd/yyyy [HH:mm:ss]

API Results

The following page show examples of results that can be returned by the API

API_Results

Retrieved from "http://api.1shoppingcart.com/index.php?title=API_Methods"