Coding 102 REST API Basics Using Spark
•Download as PPTX, PDF•
0 likes•1,142 views
David Staudt and Steve Sfartz
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Viewers also liked
Viewers also liked (13)
Similar to Coding 102 REST API Basics Using Spark
Similar to Coding 102 REST API Basics Using Spark (20)
More from Cisco DevNet
More from Cisco DevNet (12)
Recently uploaded
Recently uploaded (20)
Coding 102 REST API Basics Using Spark
- 1. Coding 102 REST API Basics using Spark David STAUDT, Developer Evangelist, dstaudt@cisco.com Stève SFARTZ, API Evangelist, stsfartz@cisco.com DEVNET-2002
- 2. • REST API Basics • A tour of Cisco Spark API • Interactive Documentation Hands-on • Postman Hands-on • Javascript examples • Pre-requisites • You know how to forge API requests with Postman (or a similar REST client) • If not, attend DEVNET-1001: Coding 101- Introduction to REST APIs Agenda
- 3. REST API Basics Coding 101 Prerequisites – DEVNET1001
- 4. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public What is so great about REST? same concept, many Cisco APIs Easy to Build Web apps Mobile apps M2M, Bots… REST API DEVNET-2002 4
- 5. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Terminology of a REST API query GET /../repos?page=1 HTTP/1.1 accept: application/json HTTP 200 OK browser api.github.com:443 method path protocol status code https://api.github.com/users/CiscoDevNet/repos?page=1&per_page=2 headers URL: response body HTTP request HTTP response api endpoint JSON payload parameters DEVNET-2002 5
- 6. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public http://getpostman.com • Want to code along? Install POSTMAN now • Free tool to forge API requests, examine responses DEVNET-2002 6
- 7. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public method url request headers status code response headers content-type response body query parameters DEVNET-2002 7
- 8. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public JSON syntax • square brackets for lists • curly braces for objects • name/value pairs for properties, separated by commas • pick an online editor • http://codebeautify.org/jsonviewer http://www.jsoneditoronline.org DEVNET-2002 8
- 9. Cisco Spark for Developers A tour of Cisco Spark APIs
- 10. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Cisco Spark Secure & Open Complete & Simple Spark for Developers User Integrations, APIs/SDKs, etc. Spark Hybrid Services Cloud + Prem Partner Services Interconnect Message Meeting Call DEVNET-2002 10
- 11. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public ‘Your App’ now with Cisco Collab! Spark APIs Extend Cisco Collaboration Cloud GET POST DELETE PUT /Rooms /Memberships /Messages /Teams /People DEVNET-2002 11DEVNET-2002 11 /Webhooks
- 12. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Cisco Spark API v1 (July 2016) /People /Rooms /Membership /Messages /Teams /Webhooks List People List Rooms List Memberships List Messages List Teams List Webhooks Create a Room Create a Membership Create a Message Create a Team Create a Webhook Get Person Details Get Room details Get Membership details Get Message details Get Team details Get Webhook details Update a Room Update a Membership Update a Team Update a Webhook Delete a Room Delete a Membership Delete a Message Delete a Team Delete a Webhook GET POST DELETE PUT DELETE DELETE DELETE PUT PUT POST POST POST GET GET GET GET GET GET GET GETGET DEVNET-2002 12 DELETE PUT POST GET GET
- 13. Hands on list your Spark Rooms with the Interactive Documentation
- 14. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Developer Portal Interactive API documentation Client SDKs developer.ciscospark.com 24/7 Dev Support DEVNET-2002 14
- 15. 15
- 16. 16
- 17. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Hands-on Instructions • Go to « List Rooms » documentation on the Developer Portal https://developer.ciscospark.com/resource-rooms.html • Login: and Turn « Test Mode » on: • Run the query: 17
- 18. Hands on add a Message to a Room with Postman
- 19. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Demo : list Rooms from Postman DEVNET-2002
- 20. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco PublicDEVNET-2002 Hands on Import the Postman collection bit.ly/DEVNET2002
- 21. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Hands on • Get your Cisco Spark Token from developer.ciscospark.com • Fill in the Authentication Header • Authorization : Bearer YOUR_SPARK_TOKEN • List some Rooms you are a member of Add a Message to a Room with Postman 21
- 22. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Hands on • Pick a Room identifier « RoomId » Add a Message to a Room with Postman 22DEVNET-2002
- 23. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Hands on • Forge a POST request to create a message • API documentation : https://developer.ciscospark.com/endpoint-messages-post.html Add a Message to a Room with Postman DEVNET-2002 23
- 24. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public POSTED !!! • 200 OK • Check Message Id & attachments DEVNET-2002 24
- 25. Cisco Spark for Developers Spark API calls in Javascript
- 26. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public How to request from Javascript • A benefit of REST is that you can invoke Spark from any language • Hand code with your favorite HTTP client library • Or generate code from Postman • OAuth 2 to inject user API token Do It Yourself … with Postman code assistants DEVNET-2002 26
- 27. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public How to request from NodeJS 1. Generate a nodejs skeleton from Postman, 2. Run from the command line Do It Yourself … with Postman code assistants DEVNET-2002 27
- 28. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public How to request from NodeJS • Official « ciscospark » SDK • Community SDKs • nmarus Sparky, • drkchiloll/csco-spark • … … or choose with a ready-to-use SDK https://github.com/nmarus/sparky https://www.npmjs.com/package/ciscospark DEVNET-2002 28
- 29. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Continue Your Education in the DevNet Zone • Take a Spark Learning Lab 1. Create Rooms, Adding Participants and Posting Messages 2. Learn to create a Webhook that will subscribe to new messages in a room 3. Register a new Spark app, and authenticate from a browser based app https://developer.ciscospark.com/samples-tutorials.html • Attend other Spark API sessions or take an instructor-driven Workshop • DEVNET-2020: [Workshop] Working with Spark APIs • DEVNET-2021: Spark API Authentication - Bots and Oauth • DEVNET-2025: [Workshop] Build a Multi-Function iPaaS Application Using Python • DEVNET-3002: [Workshop] Tour the DevNet Quiz App (Spark & Tropo Integration) • BRKDEV-2004: Cloud Integration Platform Use-Cases and Coding Walk-Through DEVNET-2002 29
- 30. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Continue Your Education in the DevNet Zone • Take the DevNet « Coding Track » • DEVNET-1001: Coding 101, Introduction to REST APIs • DEVNET-1060: Intro to API Authentication Types (Oauth, token HTTP Basic) • DEVNET-1080: Introduction to Git • DEVNET-2002: Coding 102, REST API Basics using Spark • DEVNET-2003: Coding 102, REST API Basics using APIC-EM • DEVNET-2006: Coding 103, Deep Dive on JSON & more Python • Meet the Experts at the Demo Pods • Become a DevNet Community member www.developer.cisco.com DEVNET-2002 30
- 31. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Continue Your Education • Demos in the Cisco campus • Walk-in Self-Paced Labs • Lunch & Learn • Meet the Engineer 1:1 meetings • Related sessions DEVNET-2002 31
- 32. © 2016 Cisco and/or its affiliates. All rights reserved. Cisco Public Complete Your Online Session Evaluation Don’t forget: Cisco Live sessions will be available for viewing on-demand after the event at CiscoLive.com/Online • Give us your feedback to be entered into a Daily Survey Drawing. A daily winner will receive a $750 Amazon gift card. • Complete your session surveys through the Cisco Live mobile app or from the Session Catalog on CiscoLive.com/us. DEVNET-2002 32
Editor's Notes
- http://www.ciscolive.com/us/learn/sessions/session-catalog/?search=DEVNET-2002 Join this session to learn about REST principles and get hands on with Cisco Spark APIs. Throughout this session, we'll illustrate the REST APIs principles with Cisco Spark examples. You'll learn to forge your own REST API requests with Postman, understand rudiments of authentication, and get insights of programming in NodeJS, via instructor-driven demos. Pre-requisites : the participant knows to forge API requests with Postman, and/or attended the Coding 101 session
- The same HTTP principles that apply to the Web (HTML page) - apply to Web APIs Here ‘s what happens when you consume the github API, More concretely : you hit an Endpoint (here the host: github.com, port: 443), remember it is what HTTPS defaults to, the connection is established and the HTTP protocol is used as specified by the scheme, the resource path /CiscoDevNet is asked for, with a GET method, the web browser adds an Accept Header to the request because an HTML page is what it expects the server to return This is the request, now let’s look at the answer : the github server returns on the same channel a response with the statuts code 200 to tell everything went OK and it writes the JSON contents on the wire Now, we got this HTTP intrinsics, we’re ready to place the call over the wire with POSTMAN. -- ADVANCED DO : open Chrome, go to github, open Dev Toolbar, show what’s happening Several resources are being accessed To different endpoints And different types of Data are being sent and received. That’s the way the Web works, we issue HTTP calls, asking for resources. Then all you need to know to start building calls yourself.
- If you have not installed Postman, this is the last call. Go to getpostman.com, Click Chrome App for the purpose of this training
- Now let’s place our HTTP request to github.com Leave the GET method as is. Enter the URL of the resource. Press the Send button DO : open POSTMAN, issue the call https://github.com/CiscoDevNet Postman issues the HTTP call on your behalf, and shows the response transmitted by the Github service : statuts of 200 OK if everything went ok If you get 404, the URL is malformed The HTML page contents are placed in the Body Note that the HTML content-type specified by the server is also displayed If you encounter an issue, ask for assistance in the Spark room and sending a Snapshot of your work in Postman may be your best bet to get an hand from the team.
- Carrets for list of elements, Braces to describe an element, Contents can also be nested. See how JSON entry ‘s got a name which makes it easy to understand what’s received. Though, the API documentation can help when you’re wondering.
- Let’s break it down into the 3 elements. SPARK MESSAGING – is an easy to use, always connected, service built on the idea of VIRTUAL ROOMS with a excellent MOBILE EXPERIENCE. Messaging, content sharing and BASIC conferencing capabilities are now all in one place. These “rooms” reduce the need for other tools like email and SHAREPOINT that were not truly built to support these types of workers and workstyles. SPARK MEETINGS – People shouldn’t have to worry about what KIND OF MEETING they’re having. Video Rooms, home office, branch office, Driver’s seat, Airport…Face to Face Video, Voice, and Content Sharing from any DEVICE, any ROOM, and any WORK ENVIRONMENT. Leveraging the #1 Web collaboration tool WebEx. SPARK CALL – This is your phone system or PBX in the cloud. One-touch directory dialing, Single Number Reach, Single Voicemail from any device, anywhere. All delivered in a single experience and managed through a single Cloud Collaboration Management Portal. Cloud Collaboration Management provides a single tool for administration, entitlement, management and reporting for Cisco Spark and Cisco WebEx Building on these 3 ELEMENTS . Cisco Spark is an Open Platform with… Open APIs for application integrations and a playground for developers Partner Services provides inbound dialing, and PSTN connectivity And Hybrid Services for integrating Cloud Spark applications with existing on prem investments
- Note: that this is the only way to create a 1 person only room
- Use our open APIs, available through our site or as a JavaScript SDK Use our cloud APIs alone or in tandem to customize the way administrators and teams use Cisco Spark capabilities. Share all the cool integrations you create with us, so we can publicize it with our community. Utilize a 24/7 world-class support desk powered by Tropo to answer your questions and discuss your ideas. We will be enhancing our APIs and publishing new ones so check back often. Initial APIs: /People /Rooms /Messages /Memberships /Webhooks Note: this site is launching in a ‘preview’ mode with an initial API framework for partners and customers to leverage. We will transition from preview to GA once we have additional APIs and SDKs available in CY 2016.
- Note: that this is the only way to create a 1 person only room
- A Postman collection regroups a set of API requests You can save any requests you forge manually into a collection, group several requests and share your collections with Postman If you need to inject dynamic parameters such as API token you can inject them using the {{ variable }} notation. Note that it is also possible to share environments with Postman
- var settings = { "async": true, "crossDomain": true, "url": "https://api.ciscospark.com/v1/rooms?max=3&type=group", "method": "GET", "headers": { "authorization": "Bearer YOUR_SPARK_TOKEN", "cache-control": "no-cache",} } $.ajax(settings).done(function (response) { console.log(response); });
- Note that adding your Spark Token into a Web page is not something you want to do Rather have it dynamically injected
- https://www.npmjs.com/package/ciscospark https://github.com/drkchiloll/csco-spark https://github.com/nmarus/sparky