VerticalResponse: From SOAP to REST - API Meetup Aug 2014
-
Upload
joe-takeuchi -
Category
Marketing
-
view
109 -
download
2
description
Transcript of VerticalResponse: From SOAP to REST - API Meetup Aug 2014
![Page 1: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/1.jpg)
VerticalResponse APIJourney from SOAP to REST & Lessons Learned
![Page 2: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/2.jpg)
Agenda● About VR
● Early VR API
● SOAP to REST
● Lessons Learned
● Road Ahead
![Page 3: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/3.jpg)
VerticalResponse helps small business grow and connect
with their customers wherever they are. Our full suite of
online tools lets SMB’s do all marketing – email, social
media, mobile and more – easily from one account.
![Page 4: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/4.jpg)
VR Features
● Founded in 2001.
● Released new product in March 2014
● Email and Social marketing platform
● Responsive, professional-looking templates
● Drag and drop email editor
● Robust list management capabilities
● Powerful analytics for email and social campaigns
● REST API
● Integrations Marketplace
![Page 5: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/5.jpg)
Early API
● Inspired from Salesforce’s AppExchange
● Built to give partners and resellers more control
● REST was still nascent , lack of organization support
● Not built with scalability in mind.
● No clear design processes were followed.
● Shift to REST was not easy.
![Page 6: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/6.jpg)
Enter REST
![Page 7: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/7.jpg)
New Platform, New Methodology
![Page 8: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/8.jpg)
Operation Developer Love.
![Page 9: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/9.jpg)
API’s not an afterthought
![Page 10: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/10.jpg)
● Build relevant API
● Create Smart Integrations
● Create Integrations Marketplace
● Develop a rich developer community
● Marketing and Support
API as a Product
![Page 11: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/11.jpg)
Design
![Page 12: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/12.jpg)
REST API Design
HATEOAS based Design
○ Hypermedia as the engine of
application state
○ Consistent API Design
○ Easy for Client Applications
○ Know one object, know them
all
○ Growing pains
{ "url": "https://vrapi.verticalresponse.com/api/v1/contacts/8796094885659", "attributes": { "id": 8796094885659, "first_name": Lily, "last_name": Evans, "email": "[email protected]", "optin_status": "optin", "messageable": false, "status": "blocked" }, "links": { "up": { "url": "https://vrapi.verticalresponse.com/api/v1/contacts" }, "lists": { "url": "https://vrapi.verticalresponse.com/api/v1/contacts/8796094885659/lists" }, "messages": { "url": "https://vrapi.verticalresponse.com/api/v1/contacts/8796094885659/messages" }, "stats": { "url": "https://vrapi.verticalresponse.com/api/v1/contacts/8796094885659/stats" } }}
![Page 13: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/13.jpg)
Challenges
![Page 14: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/14.jpg)
Challenges
● Mindset Change - API as a Product
● Demonstrate Value Proposition to Business
● API Management - Build vs Partner
● Design First, Implement later
● Document design guidelines
● Adhere to design
![Page 15: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/15.jpg)
Lessons Learned
![Page 16: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/16.jpg)
Build an API Program, not just API’s
![Page 17: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/17.jpg)
Create a Roadmap and implement against it
![Page 18: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/18.jpg)
Measure Success, Identify KPI’s
![Page 19: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/19.jpg)
There is no substitute for good design
![Page 20: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/20.jpg)
Set up design guidelines and adhere to it
![Page 21: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/21.jpg)
Code Reviews should check against design guidelines
![Page 22: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/22.jpg)
Market and Support your API’s
![Page 23: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/23.jpg)
Build support plan and process
![Page 24: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/24.jpg)
Lessons from API Support
● Solid documentation is essential
● Self-service onboarding
● Support tickets vs. Web Forum
● “Dualing APIs”
● Sunset and Migration
![Page 25: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/25.jpg)
Road Ahead
![Page 26: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/26.jpg)
Future of the VR API
● Work with developers to build third party integrations.
● Create strategic integrations with partners.
● Building a robust marketplace
● Actively participate in developer events
![Page 27: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/27.jpg)
Useful Links
● VR Developer Portalhttps://developer.verticalresponse.com
● Support Grouphttps://groups.google.com/forum/#!forum/vertical-response-rest-api-group
● Bloghttp://www.verticalresponse.com/blog/product/
![Page 28: VerticalResponse: From SOAP to REST - API Meetup Aug 2014](https://reader034.fdocuments.in/reader034/viewer/2022052400/55961bba1a28ab89018b459f/html5/thumbnails/28.jpg)
Q and A