SpreeConf DC 2013: Introducing the Spree Integrator

A detailed look at the first Spree Integrator release.

Transcript

1. Spree Integrator
2. Brian Quinn CTO & Co-founder of Spree Commerce, Inc. github.com/bdq twitter.com/briandq
3. What is the integrator?
6. x
7. x x
8. x x x
9. x x x x
10. x x x x x
11. x x x x x x
12. x x x x x x x
13. x x x x x x x x
14. x x x x x x x x x
15. x x x x x x x x x x
16. x x x x x x x x x x x
17. x x x x x x x x x x x
18. x x x x x x x x x x x x
19. bingo! x x x x x x x x x x x x
20. History
21. “Messaging System”
22. Code name: Augury
23. TM & © Wizards of the Coast
24. Overview
25. Integrator Overview
26. Spree Store Integrator Overview
27. Spree Store Integrator Overview
28. Spree Store Integrator Mandrill NetSuite Shipwire Custom Overview
29. Spree Store Integrator Mandrill NetSuite Shipwire Custom SendGrid Xero Amazon Custom So Ne E Cu Overview
30. Orders Products Users Overview
31. Orders Products Users Payments Shipments Overview
32. Orders Products Users Stock Payments Shipments Overview
35. Use Case
36. My Spree Store ✔ Mandrill for transactional emails ✔ Shipwire for drop shipping ✔ Netsuite for accounting ✔ MixPanel for analytics
37. Spree Integrator Mandrill Endpoint Overview
38. Spree Integrator orders updated since (timestamp) Mandrill Endpoint Overview
39. Spree Integrator orders updated since (timestamp) updated orders Mandrill Endpoint Overview
40. Spree Integrator orders updated since (timestamp) updated orders Mandrill Endpoint detect new orders Overview
41. Spree Integrator orders updated since (timestamp) updated orders Mandrill Endpoint send order confirmation email detect new orders Overview confirmation
42. Spree Integrator orders updated since (timestamp) updated orders confirmation Overview
43. Spree Integrator orders updated since (timestamp) updated orders send shipment to fulfillment detect ready shipments confirmation Overview Shipwire Endpoint
44. Spree Integrator Shipwire Endpoint Overview
45. Spree Integrator poll for shipments (bookmark) Shipwire Endpoint Overview
46. Spree Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint Overview
47. Spree Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint update shipment state + tracking Overview
48. Spree Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint update shipment state + tracking confirmation Overview
49. Overview Spree Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint update shipment state + tracking confirmation
50. Overview Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint + tracking Mandrill Endpoint
51. Overview Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint + tracking Mandrill Endpoint
52. Overview Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint + tracking Mandrill Endpoint send shipment notification email
53. Overview Integrator poll for shipments (bookmark) new shipments Shipwire Endpoint + tracking Mandrill Endpoint send shipment notification email confirmation
54. order:new
55. order:new send order confirmation email
56. order:new send order confirmation email capture payment (if stock available)
57. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment
58. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order
59. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order update accounts with order
60. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order update accounts with order subscribe customer to mailing list
61. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order update accounts with order subscribe customer to mailing list watch for fulfillment notifications
62. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order update accounts with order subscribe customer to mailing list watch for fulfillment notifications decrease stock levels
63. order:new send order confirmation email capture payment (if stock available) send shipment to fulfillment update analytics with order update accounts with order subscribe customer to mailing list watch for fulfillment notifications send shipment notification email decrease stock levels
64. Message Flow
65. MSG Message Flow
66. MSG Incoming Queue Message Flow
67. MSG Incoming Queue Router Message Flow
68. MSG Incoming Queue Router Message Flow
69. MSG Incoming Queue Router Consumer Registry Message Flow
70. MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow
71. order:new Message Flow MSG Incoming Queue Router Consumer Registry Accepted Queue
72. order:new 1 x order:new Message Flow MSG Incoming Queue Router Consumer Registry Accepted Queue
73. order:new 1 x order:new order:new - Mandrill - NetSuite - MixPanel Message Flow MSG Incoming Queue Router Consumer Registry Accepted Queue
74. order:new 1 x order:new order:new - Mandrill - NetSuite - MixPanel 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow MSG Incoming Queue Router Consumer Registry Accepted Queue
75. Accepted Queue 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
76. Accepted Queue Dispatcher 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
77. Accepted Queue Dispatcher 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
78. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
79. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
80. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
81. Accepted Queue Dispatcher Mandrill order:new 1 MixPanel order:new 3 NetSuite order:new 2 200: success 200: success 500: fail! 3 x order:new - Mandrill - NetSuite - MixPanel Message Flow
82. Accepted Queue Dispatcher NetSuite 1 x order:new - NetSuite Message Flow
83. Accepted Queue Dispatcher NetSuite order:new 2 500: fail! 1 x order:new - NetSuite order:new 2 500: fail! order:new 2 500: fail! order:new 2 200: success Message Flow
84. Accepted Queue Dispatcher NetSuite order:new 2 500: fail! 1 x order:new - NetSuite order:new 2 500: fail! order:new 2 500: fail! order:new 2 200: success Message Flow
85. Benefits
86. Pull
87. Pull Spree - orders, products, users, stock transfers
88. Pull Spree - orders, products, users, stock transfers 3rd Parties - shipments, payments, purchase orders
89. order Have we seen this order before?
90. order Have we seen this order before? no: push message order:new
91. order Have we seen this order before? yes Generate diff no: push message order:new
92. order Have we seen this order before? yes Generate diff no: push message order:new Order has really changed?
93. order Have we seen this order before? yes Generate diff yes: push message order:updated no: push message order:new Order has really changed?
94. Why pull not push?
95. Why pull not push? •Less dependencies on the client side.
96. Why pull not push? •Less dependencies on the client side. •We can poll new collections easier.
97. Why pull not push? •Less dependencies on the client side. •We can poll new collections easier. •We control the rate of flow.
98. Why pull not push? •Less dependencies on the client side. •We can poll new collections easier. •We control the rate of flow. •Nobody has needed push yet.
99. Versioned
100. Order V1 parent: null new Versioning
101. Order V1 parent: null new send order confirmation email Versioning
102. Order V1 parent: null Order V2 parent: V1 update new send order confirmation email Versioning
103. Order V1 parent: null Order V2 parent: V1 update new send order confirmation email capture payment Versioning
104. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update send order confirmation email capture payment Versioning
105. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update send order confirmation email capture payment send shipment to fulfillment Versioning
106. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update update Order V4 parent: V3 send order confirmation email capture payment send shipment to fulfillment Versioning
107. Order V1 parent: null Order V2 parent: V1 update new Order V3 parent: V2 update update Order V4 parent: V3 send order confirmation email capture payment send shipment to fulfillment send shipment confirmation Versioning
108. Versioning Implying events
109. Order V1 state: complete Versioning
110. Order V1 state: complete Versioning update Order V2 state: canceled
111. Order V1 state: complete Versioning update Order V2 state: canceled push message order:update
112. Order V1 state: complete Versioning update Order V2 state: canceled order:canceled push message order:update
113. Asynchronous
114. Traceable
115. Messages (8)
116. Messages (10)
117. Replay-able
118. Scalable
119. Flexible
120. Managed
121. Architecture
122. Consumers
123. Consumers Internal
124. Consumers Internal External
125. Consumers Internal External (endpoints)
126. Core Fully Managed SaaS
127. Endpoints SaaS & Self-managed
128. Incoming Queue Router Consumer Registry Accepted Queue Architecture
129. Managed Incoming Queue Router Consumer Registry Accepted Queue Architecture
130. Accepted Queue Dispatcher Mandrill MixPanel NetSuite Architecture
131. Managed Accepted Queue Dispatcher Mandrill MixPanel NetSuite Architecture
132. Managed Self hosted Architecture Accepted Queue Dispatcher Mandrill NetSuite MixPanel
133. Self hosted Managed Architecture Accepted Queue Dispatcher Mandrill MixPanel NetSuite
134. Message Basics
135. JSON
136. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 } Message: Overview
137. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 } Message: Overview
138. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { 5 "id": 15913, 6 "amount": "129.57", 7 "state": "pending", 8 "payment_method": { 9 "id": 931422127, 10 "name": "Credit Card", 11 "environment": "production" 12 } 13 } 14 } 15 } Message: Overview
139. message:
140. Order New order:new Order Updated order:updated Order Cancelled order:cancelled
141. Order New order:new Order Updated order:updated Order Cancelled order:cancelled Shipment Confirmation shipment:confirmation Shipment Ready shipment:ready Shipment Rejected shipment:rejected
142. Order New order:new Order Updated order:updated Order Cancelled order:cancelled Payment Ready payment:ready Shipment Confirmation shipment:confirmation Shipment Ready shipment:ready Payment Captured payment:captured Shipment Rejected shipment:rejected Payment Declined payment:declined
143. payload:
144. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { ... }, 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 ... 9 }, 10 "current": { 11 "number": "R123123123", 12 ... 13 }, 14 } 15 } 16 } Message: Payload
145. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { ... }, 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 ... 9 }, 10 "current": { 11 "number": "R123123123", 12 ... 13 }, 14 } 15 } 16 } Message: Payload
146. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { ... }, 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 ... 9 }, 10 "current": { 11 "number": "R123123123", 12 ... 13 }, 14 } 15 } 16 } Message: Payload
147. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { ... }, 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 ... 9 }, 10 "current": { 11 "number": "R123123123", 12 ... 13 }, 14 } 15 } 16 } Message: Payload
148. 1 { 2 "message": "payment:ready", 3 "payload": { 4 "payment": { ... }, 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 ... 9 }, 10 "current": { 11 "number": "R123123123", 12 ... 13 }, 14 } 15 } 16 } Message: Payload
149. Custom Endpoints
150. HTTP
151. Message: message_id 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { 5 "payment": { ... }, 6 "order": { 7 "actual": { 8 "number": "R123123123", 9 ... 10 }, 11 "current": { 12 "number": "R123123123", 13 ... 14 }, 15 } 16 } ...
152. Message: message_id 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "payment:ready", 4 "payload": { 5 "payment": { ... }, 6 "order": { 7 "actual": { 8 "number": "R123123123", 9 ... 10 }, 11 "current": { 12 "number": "R123123123", 13 ... 14 }, 15 } 16 } ...
153. Dispatcher Endpoint order:new
154. Dispatcher Endpoint POST JSON { ... } order:new
155. Dispatcher Endpoint {message_id: x} HTTP: 200 POST JSON { ... } order:new
156. Dispatcher Endpoint {message_id: x} HTTP: 200 POST JSON { ... } order:new --------------- ✓
157. Response: Basic 1 { 2 "message_id": "518783ac7575e46507000001" 3 }
158. Basic Example
159. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end
160. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end
161. Endpoint: Sinatra 1 require 'sinatra' 2 require 'sinatra/json' 3 4 class SimpleEndpoint < Sinatra::Base 5 helpers Sinatra::JSON 6 7 post '/' do 8 message = JSON.parse(request.body.read) 9 10 json 'message_id' => message['message_id'] 11 end 12 end <- DO INTERESTING THINGS HERE
162. Endpoint: Node.js 1 var express = require('express'); 2 var app = express(); 3 4 app.use(express.bodyParser()); 5 6 app.post('/', function(req, res){ 7 var id = req.body['message_id']; 8 res.setHeader('Content-Type', 'application/json'); 9 res.end(JSON.stringify({ "mesage_id": id})); 10 }); 11 app.listen(3000);
163. Endpoint: Node.js 1 var express = require('express'); 2 var app = express(); 3 4 app.use(express.bodyParser()); 5 6 app.post('/', function(req, res){ 7 var id = req.body['message_id']; 8 res.setHeader('Content-Type', 'application/json'); 9 res.end(JSON.stringify({ "mesage_id": id})); 10 }); 11 app.listen(3000);
164. 1 <?php 2 $message = json_decode(file_get_contents('php://input')); 3 4 $response = array( 5 'message_id' => $message->message_id 6 ); 7 8 header('Content-type: application/json'); 9 echo json_encode($response); 10 ?> Endpoint: PHP
168. Endpoint Base https://github.com/spree/endpoint_base
169. Example: Endpoint Base 1 class SimpleEndpoint < EndpointBase 2 post '/' do 3 process_result 200, {'message_id' => @message['message_id'] } 4 end 5 end
170. Demo Endpoint
171. Demo Endpoint Customer stalker endpoint
172. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = 'iQ55...' 4 c.consumer_secret = 'YQoQ...' 5 c.oauth_token = '8213...' 6 c.oauth_token_secret = '6Rwn...' 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
173. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = 'iQ55...' 4 c.consumer_secret = 'YQoQ...' 5 c.oauth_token = '8213...' 6 c.oauth_token_secret = '6Rwn...' 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
174. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = 'iQ55...' 4 c.consumer_secret = 'YQoQ...' 5 c.oauth_token = '8213...' 6 c.oauth_token_secret = '6Rwn...' 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
175. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = 'iQ55...' 4 c.consumer_secret = 'YQoQ...' 5 c.oauth_token = '8213...' 6 c.oauth_token_secret = '6Rwn...' 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
176. Stateless
177. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { ... }, 5 "parameters": [ 6 { 7 "name": "twitter.consumer_key", 8 "value": "iQ55k..." 9 }, 10 { 11 "name": "twitter.consumer_secret", 12 "value": "YQoQS..." 13 } 14 ] 15 } Message: Parameters
178. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { ... }, 5 "parameters": [ 6 { 7 "name": "twitter.consumer_key", 8 "value": "iQ55k..." 9 }, 10 { 11 "name": "twitter.consumer_secret", 12 "value": "YQoQS..." 13 } 14 ] 15 } Message: Parameters
179. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = @config['twitter.consumer_key'] 4 c.consumer_secret = @config['twitter.consumer_secret'] 5 c.oauth_token = @config['twitter.oauth_token'] 6 c.oauth_token_secret = @config['twitter.oauth_token_secret'] 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
180. Endpoint: Sinatra 1 post '/follow' do 2 Twitter.configure do |c| 3 c.consumer_key = @config['twitter.consumer_key'] 4 c.consumer_secret = @config['twitter.consumer_secret'] 5 c.oauth_token = @config['twitter.oauth_token'] 6 c.oauth_token_secret = @config['twitter.oauth_token_secret'] 7 end 8 9 Twitter.follow(@msg['payload']['order']['actual']['twitter']) 10 11 process_result 200, { 'message_id' => @msg[:message_id], 12 'following' => Twitter.following.map &:name } 13 end
181. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "parameters": [ 4 { 5 "name": "last_follower", 6 "value": "@briandq" 7 } 8 ] 9 } Message: Parameters Response
182. Events
184. “Followed customer on Twitter”
185. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "events": [ 4 { 5 "code": 200 6 } 12 ] 13 } Response: Events
186. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "events": [ 4 { 5 "code": 200 6 } 12 ] 13 } Response: Events
187. Humanizer 200: "Followed customer on Twitter"
188. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "events": [ 4 { 5 "code": 200, 6 "username": "@briandq" 7 } 8 ] 9 } Response: Events
189. Humanizer 200: "Followed {{username}} on Twitter"
190. “Followed @briandq on Twitter”
191. New Messages
192. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "events": [ { "code": 200 } ], 4 "messages": [ 5 { 6 "message": "customer:followed", 7 "payload": { 8 “username": "@briandq", 9 } 10 } 11 ] 12 } Response: Messages
193. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "events": [ { "code": 200 } ], 4 "messages": [ 5 { 6 "message": "customer:followed", 7 "payload": { 8 “username": "@briandq", 9 } 10 } 11 ] 12 } Response: Messages
194. Failures
195. Dispatcher Endpoint order:new
196. Dispatcher Endpoint POST JSON { ... } order:new
197. Dispatcher Endpoint { reason: X } HTTP: 500 POST JSON { ... } order:new
198. Dispatcher Endpoint { reason: X } HTTP: 500 POST JSON { ... } order:new order:new ⨯ attempts: 1 attempt_at: 14:02
199. Dispatcher Endpoint order:new order:new ⨯ attempts: 1 attempt_at: 14:02
200. Dispatcher Endpoint { reason: Y } HTTP: 500 POST JSON { ... } order:new order:new ⨯ attempts: 2 attempt_at: 14:08
201. 1 post '/follow' do 2 Twitter.configure do |config| 3 config.consumer_key = 'iQ55...' 4 config.consumer_secret = 'YQoQ...' 5 config.oauth_token = '8213...' 6 config.oauth_token_secret = '6Rwn...' 7 end 8 9 begin 10 Twitter.follow(@msg['payload']['order']['twitter']) 11 12 process_result 200, { 'message_id' => @msg[:message_id], 13 'following' => Twitter.following.map &:name } 14 rescue 15 process_result 500, 16 { 'username' => @msg['payload']['order']['twitter'] } 17 end 18 19 end Endpoint: Sinatra
202. 1 post '/follow' do 2 Twitter.configure do |config| 3 config.consumer_key = 'iQ55...' 4 config.consumer_secret = 'YQoQ...' 5 config.oauth_token = '8213...' 6 config.oauth_token_secret = '6Rwn...' 7 end 8 9 begin 10 Twitter.follow(@msg['payload']['order']['twitter']) 11 12 process_result 200, { 'message_id' => @msg[:message_id], 13 'following' => Twitter.following.map &:name } 14 rescue 15 process_result 500, 16 { 'username' => @msg['payload']['order']['twitter'] } 17 end 18 19 end Endpoint: Sinatra
203. Humanizer 200: "Followed {{username}} on Twitter" 500: "Failed to follow {{username}} on Twitter"
204. Delayed
205. Dispatcher Endpoint order:new
206. Dispatcher Endpoint POST JSON { ... } order:new
207. Dispatcher Endpoint { delay: n } HTTP: 200 POST JSON { ... } order:new
208. 1 { 2 "message_id": "518783ac7575e46507000001", 3 "delay ": 600, 4 "update_url": "http://example.com/some/path?value=x" 5 } Response: Delayed
209. Dispatcher Endpoint { delay: n } HTTP: 200 POST JSON { ... } order:new
210. Dispatcher Endpoint { delay: n } HTTP: 200 POST JSON { ... } order:new --------------- ✓
211. Dispatcher Endpoint { delay: n } HTTP: 200 POST JSON { ... } order:new --------------- ✓ push remote:poll
212. Registering Endpoints
213. Registering Endpoints •Message(s)
214. Registering Endpoints •Message(s) •URL
215. Registering Endpoints •Message(s) •URL •Token
216. Registering Endpoints •Message(s) •URL •Token •Parameters
217. Registering Endpoints •Message(s) •URL •Token •Parameters •Filters
218. Registering Endpoints •Message(s) •URL •Token •Parameters •Filters •Events (keys & details)
219. Registering Endpoints •Message(s) •URL •Token •Parameters •Filters •Events (keys & details) •Options
220. Messages [‘order:new’, ‘order:updated’, ‘order:canceled’]
221. URL SSL Required
222. Token
223. Parameters
225. Filters
226. Filters Path
227. Filters Path Operator
228. Filters Path Operator Value
229. Filter: Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "twitter": "@briandq", 10 "line_items": [ ... ] 11 } 12 } 13 }
230. Filter: Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "twitter": "@briandq", 10 "line_items": [ ... ] 11 } 12 } 13 }
231. Filter: Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "twitter": "@briandq", 10 "line_items": [ ... ] 11 } 12 } 13 } Path: payload.order.actual.twitter
232. Filter: Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "twitter": "@briandq", 10 "line_items": [ ... ] 11 } 12 } 13 } Path: payload.order.actual.twitter Operator: is_not
233. Filter: Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "twitter": "@briandq", 10 "line_items": [ ... ] 11 } 12 } 13 } Path: payload.order.actual.twitter Operator: is_not Value: nil
234. MSG Incoming Queue Router Consumer Registry Message Flow: Filters
235. MSG Incoming Queue Router Consumer Registry Message Flow: Filters Apply Filters
236. MSG Incoming Queue Router Consumer Registry Accepted Queue Message Flow: Filters Apply Filters
237. Events
238. Events 1. Provide human readable logs
239. Events 1. Provide human readable logs 2. Prevent duplicate execution
240. Event Key(s) Highlights the unique identifier
241. Event: Key Example 1 { 2 "message_id": "518783ac7575e46507000001", 3 "message": "order:new", 4 "payload": { 5 "order": { 6 "actual": { 7 "number": "R123123123", 8 "total": "199.99", 9 "email": "brian@spreecommerce.com", 10 "line_items": [ ... ] 11 } 12 } 13 } Name: order_number Path: payload.order.actual.number
242. Event Detail(s) Extra data for display
244. Demo
248. What’s planned?
249. Endpoint Hosting
250. Render & Transform
251. Render & Transform
252. Discoverability
253. Self Provisioning
254. More Tools
257. Get Started!
258. Talk to us!
259. Guides http://edgeguides.spreecommerce.com/integration/
260. Open Source
261. Mandrill Basic Sinatra Endpoint Fully open-source https://github.com/spree/mandrill_endpoint
262. Shipwire Basic Sinatra Endpoint Fully open-source https://github.com/spree/shipwire_endpoint
263. QuickBooks Delayed Endpoint Fully open-source https://github.com/spree/quickbooks_endpoint
264. Whisky?
268. Visas?
269. Alexey @devilcoders Washington @huoxito
270. Questions?