API Notifications
From Developer's API
(Difference between revisions)
| Line 1: | Line 1: | ||
| − | The 1ShoppingCart notification system sends messages via https of new events | + | The 1ShoppingCart notification system sends messages via https of new events <sup>1</sup> 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. |
===API Notifications Overview=== | ===API Notifications Overview=== | ||
| Line 6: | Line 6: | ||
=====Diagram Explained===== | =====Diagram Explained===== | ||
| − | # When a new event | + | # 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 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 | ||
| Line 16: | Line 16: | ||
# Add functionality to support your business processes. for example you can parse the ShippingInfo node and prepare shipping labels. | # Add functionality to support your business processes. for example you can parse the ShippingInfo node and prepare shipping labels. | ||
| − | + | <sup>1</sup> Currently the following events support API notification: | |
| − | + | ||
* New orders | * New orders | ||
===New Orders=== | ===New Orders=== | ||
Revision as of 17:15, 26 May 2008
The 1ShoppingCart notification system sends messages via https 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.
API Notifications Overview
The following diagram shows the typical flow of data when the 1ShoppingCart API sends 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 http
- 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 received 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