Coding 102 REST API Basics Using Spark

Editor's Notes

• #2: 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
• #6: 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.
• #7: If you have not installed Postman, this is the last call. Go to getpostman.com, Click Chrome App for the purpose of this training
• #8: 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.
• #9: 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.
• #11: 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
• #14: Note: that this is the only way to create a 1 person only room
• #15: 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.
• #19: Note: that this is the only way to create a 1 person only room
• #21: 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
• #25: 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); });
• #27: Note that adding your Spark Token into a Web page is not something you want to do Rather have it dynamically injected
• #29: https://www.npmjs.com/package/ciscospark https://github.com/drkchiloll/csco-spark https://github.com/nmarus/sparky