API Notifications
From Developer's API
(→Diagram Explained) |
|||
| Line 9: | Line 9: | ||
=====Diagram Explained===== | =====Diagram Explained===== | ||
# When a new event<sup>1</sup> is generated in your merchant account a notification token is prepared and sent over https to your notification url | # When a new event<sup>1</sup> is generated in your merchant account a notification token is prepared and sent over https to your notification url | ||
| − | # The notification request sent from the 1ShoppingCart API contains XML in the request body and holds the event type and token within its nodes | + | # The notification request sent from the [http://www.1ShoppingCart.com 1ShoppingCart] API contains XML in the request body and holds the event type and token within its nodes |
# Parse the event type and token values from the XML then call the API wrapper method corresponding to the event type to retrieve the detailed information | # Parse the event type and token values from the XML then call the API wrapper method corresponding to the event type to retrieve the detailed information | ||
| − | # The API wrapper will prepare the request to the 1ShoppingCart API and send the request over https | + | # The API wrapper will prepare the request to the [http://www.1ShoppingCart.com 1ShoppingCart] API and send the request over https |
# The API will parse out the merchant id, merchant key and token value from the request and prepare the requested data. | # The API will parse out the merchant id, merchant key and token value from the request and prepare the requested data. | ||
# The API will send the prepared data back over https to the API wrapper | # The API will send the prepared data back over https to the API wrapper | ||
Revision as of 14:37, 27 May 2008
The 1ShoppingCart notification system sends messages via http of new events 1 that have taken place on your 1ShoppingCart merchant account. A message is created in XML and sent to a user configurable URL. The notification data can then be used to call the API and retrieve specific information, such as the details of a new order.
The API notifications are sent reliably, meaning that the message will be retried until a http response 200/OK is received from your notification url. Please note that the time between each attempt will be doubled, for example, first attempt immediately, second attempt at 1 minute, third attempt at 2 minutes, fourth attempt at 4 minutes etc.
API Notifications Overview
The following diagram shows the typical flow of data when the 1ShoppingCart API sends a new event notification.
Diagram Explained
- When a new event1 is generated in your merchant account a notification token is prepared and sent over https to your notification url
- The notification request sent from the 1ShoppingCart API contains XML in the request body and holds the event type and token within its nodes
- Parse the event type and token values from the XML then call the API wrapper method corresponding to the event type to retrieve the detailed information
- The API wrapper will prepare the request to the 1ShoppingCart API and send the request over https
- The API will parse out the merchant id, merchant key and token value from the request and prepare the requested data.
- The API will send the prepared data back over https to the API wrapper
- The API wrapper receives the requested data back from the API as XML
- The notification listener receives the XML data from the API wrapper where it can verify the success attribute of the response node
- Add functionality to support your business processes. for example you can parse the ShippingInfo node and prepare shipping labels.
1 Currently the following events support API notification:
- New orders
New Orders
New order notification is sent when a new order has been placed for your merchant account.
The data contained in a new order notification is as follows:
<NewOrder><Token>{Token Value}</Token></NewOrder>