Introduction to the Web API

29 %
71 %
Information about Introduction to the Web API

Published on February 22, 2014

Author: IntegratorBrad



Presentation on introducing Web APIs to Communitech P2P Web Developers group on Feb 20, 2014

An Introduction into the Web API Brad Genereaux | @integratorbrad | | Web Developers P2P : February 2014

Housekeeping • About Me - Brad Genereaux – Healthcare and API developer – Integration Architect at Agfa Healthcare – Blogger about all the API things • Discussion and questions – Ask anytime, or at the end

Topics • • • • • API REST Security Web Examples

The API Application Programming Interface

What is an API? • Methods to access data and workflow from an application without using the application itself

API Example vs

Why an API? • Not all users are the same – Some want: – Some want / need: – And their needs and wants are ever shifting

An API Stack GUI (front-end) API (middle tier) Data Sources (back-end)

… sounds like a good framework for Web …

The REST REpresentational State Transfer

What is REST? • Architectural style (not a standard!) • Client server model • Stateless – Idempotency • Cacheable • Layered System • Uniform interface


Who RESTs? • • • • • • • Facebook Twitter Google LinkedIn Netflix Evernote Etc etc

Why REST? • • • • • Scalable Fault-tolerant Recoverable Secure Loosely coupled

What do I need to REST? Clients • Browsers • Mobile Apps • Desktop Apps Servers • “Capable of HTTP” – – – – – – Java-based .Net-based PHP Ruby Perl Etc.

Three levels of REST • Level 1 : Resources • Level 2 : Verbs • Level 3 : HATEOAS

Resources, Level 1 REST • • • • /users /users/bob /users/bob/tweets /users/bob/tweets/1

Verbs, Level 2 REST • CRUD

What is CRUD? • Standard database operations: C reate R ead U pdate D elete

Verbs, Level 2 REST • CRUD • GET /tweets (as opposed to /givemethetweets) • POST /tweets (as opposed to /createnewtweet) • PUT /tweets/1 (as opposed to /updatetweet/1) • DELETE /tweets/1 (as opposed to /removetweet/1)

RESTful Methods GET Collection URI (such as Element URI (such as PUT POST DELETE List the items in the collection and some metadata about the items Replace the entire collection with another collection Create a new entry in the collection, and return the reference Delete all the items in the collection Retrieve a specific item in the collection Replace a specific item in the collection; if it doesn't exist, create it Not generally used Delete the specific item in the collection • There are other methods less used (HEAD, OPTIONS, PATCH) for other purposes • Representations of an item are specified by the media type (MIME type) Source:

HATEOAS, Level 3 REST • Hypermedia as the engine of application state "ids" : [ 12345678, 87654321, 11223344 ] "links": [ { "rel": "UserInfo", "href": "https://.../user/12345678" }, { "rel": "Tweets", "href": "https://.../tweet/87654321" }, { "rel": "Messages", "href": "https://.../msgs/11223344" } ]

Data Formats (XML and JSON)  XML (135 characters): <tweets> <tweet type="text" id="1"> <text>REST is great!</text> </tweet> <tweet type="text" id="2"> <text>APIs forever!</text> </tweet> </tweets>  JSON (109 characters): { "tweets": [ {"type": "text", "id": "1", "text": "REST is great!"}, {"type": "text", "id": "2", "text": "APIs forever!"} ] }  XML can be validated (XML Schema), stylized (XSL), traversed (XPath), queried (XQuery), transformed (XSLT), and namespaced  JSON is easier

What makes for good REST? • Self-documenting • Nouns in path, verbs by HTTP • Complexity under the “?” – i.e., /tweets/?contains=API • Errors use HTTP error code mechanism • As simple as possible, but no simpler

REST Alternatives • SOAP (simple object access protocol) • Javascript • XML-RPC • See discussion at

Important : Know your TTFHW (Time to First Hello World) !

API Worst Practices Source: 10. Poor error handling 9. Ignoring HTTP rules 8. Exposing your underlying data model 7. Security complexity 6. Unexpected release cycles 5. Poor developer experience 4. Expecting an MVC to give you a great API 3. Assuming if you build it, they will come 2. Inadequate support 1. Poor documentation

The Security

Authentication and Authorization • Authentication : Who • Authorization : What they are allowed to do • Not your job, but your responsibility

Security Frameworks • OAuth – Authorizing services • OpenID – Facebook, Google • LDAP – Enterprise authentication

Application Security Threats Input Validation Authentication Session Management Cryptography Authorization Exception Management Configuration Management Parameter Manipulation Sensitive Information Auditing and Logging Source:

SQL Injection Consider the following pseudo-code: String topic = request.getParameter(“topic"); SQLCommand sql = new SQLCommand("select * from tweets where topic like ‘" + topic + "%’") So what happens if the parameter is: – API – REST – h3ck0rz’; drop table tweets; -Source:

The Web Client-side Access to REST

HTML5 + CSS • “HyperText Markup Language” – Characterized by the DOM (document object model) Completely ubiquitous across the Internet <html> <body> <h1>Hello World</h1> </body> </html> • “Cascading Style Sheets” – Allows for advanced stylization of content – Example: .giant { font-size: 72px; color: blue; }

JavaScript • • • • Multi-paradigm weakly-typed scripting language Used most often hand-in-hand with HTML Not Java, at all (syntax based on C) Example: alert (“Hello World!”); • Able to manipulate the DOM and interact with the browser environment

AJAX • “Asynchronous JavaScript and XML” • Group of technologies that allow for robust client interactions without reloading web pages – HTML and CSS for presentation – DOM for display and interaction of data – XML for data interchange – XMLHttpRequest for asynchronous communication – JavaScript to bring these technologies together • AJAX is the key to consuming REST

jQuery • “jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development.” • Example: $(“#h1”).html(“Hello World!”); • jQuery tests against many browser platforms and solves a lot of the problems that supporting many platforms introduces

Calling REST with jQuery Verb • Use an AJAX Call Resource $.ajax({ type : "GET", url : "", data : {"contains" : "API"}, dataType : "json", success : function(data){ alert ("Results: " + data); } }); Query parameters Media type

Tips • Use “curl” to simulate calls from your command line • Use Chrome debug tools or Firebug to watch traffic and test your Javascript • Use libraries – no need to reinvent the wheel

Other Frameworks • • • • UI Frameworks (Bootstrap, Foundation) MVC Frameworks (Angular, Backbone) Tooling (Yeoman, Lineman) Documentation (Apiary, Swagger) • No shortage of options

The Examples

Some REST API Examples • • • • • Facebook Twitter If This, Than That Twilio Demo

Facebook Graph API • Every object has an ID: • Objects can be searched: • Objects can be updated:

Twitter REST API

If This, Then That • API Integration Website -



Need more REST? • Programmable Web John Musser’s presentations: • Crafting Interfaces that Developers Love • API Craft Google Group https://!forum/api-craft

Discussion - Questions

Add a comment

Related presentations

Related pages


Using Web API with ASP.NET Web Forms. By Mike Wasson | April 3, 2012. ... Introduction. 54 mins. 2. Uniform Interface. 46 mins. 3. HttpClient. 33 mins. 4 ...
Read more

Pluralsight Introduction to the ASP.NET Web API

Pluralsight Introduction to the ASP.NET Web API. Microsoft has made it possible for you to enjoy Pluralsight's Introduction to the ASP.NET Web API course ...
Read more

Introduction to the ASP.NET Web API | Pluralsight

This course introduces the basics of the ASP.NET Web API. The ASP.NET Web API is a rich, flexible framework for building HTTP based endpoints and client ...
Read more

An Introduction to APIs - Zapier

Zapier makes it easy to automate tasks between web apps. we're ... Center → An Introduction to APIs. ... you are confident about what an API is ...
Read more

Introduction to REST and .net Web API – Martin Kearn

What is .net Web API?.Net’s Web API is an easy way to implement a RESTful web service using all of the goodness that the .net framework provides.
Read more

Introduction to ASP.NET Web API -

Note that our example uses Web API for performing a CRUD operation on a SQL Server database. However, Web API by itself doesn't mandate as to what ...
Read more


ASP.NET-Web-API ist ein Framework, das das Erstellen von HTTP-Diensten erleichtert, die eine Vielzahl verschiedener Clients bedienen können, ...
Read more

Chapter 1: Introduction - An Introduction to APIs - Zapier

APIs (application programming interfaces) are a big part of the web. In 2013 there were over 10,000 APIs published by companies for open ...
Read more

An Introduction to ASP.NET Web API - CODE Mag

ASP.NET Web API Versions and Samples. At the time this article was written, ASP.NET Web API is officially in beta with a pending release candidate (RC ...
Read more

Introduction to .NET Web API 2 with C# Part 1 | Exercises ...

Introduction Web API has been around for some years now. It is a very efficient and lightweight technology to build RESTful web services in .NET. Web API ...
Read more