Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
What is an API
Search
Jesse Wolgamott
February 24, 2017
Technology
0
170
What is an API
BEGINNER level on what is a (server-side JSON) API
Jesse Wolgamott
February 24, 2017
Tweet
Share
More Decks by Jesse Wolgamott
See All by Jesse Wolgamott
React vs React-Native
jwo
0
97
DIY Rails Authentication
jwo
0
180
ActionCable - For Not Another Chat App
jwo
3
1.4k
SlackBot.rb - Create You a Slack Bot
jwo
1
1.2k
react-rails: an isomorphic match made in heaven
jwo
0
1.2k
Docker - next big thing
jwo
0
830
Ruby 2.1 Overview
jwo
0
840
Rails 4: Appetizers
jwo
1
850
The Long Ball: Upgrading Rails from 1.2 -> 4.0
jwo
2
190
Other Decks in Technology
See All in Technology
製造現場のデジタル化における課題とPLC Data to Cloudによる新しいアプローチ
hamadakoji
0
130
Mini Tokyo 3D × PLATEAU - 公共交通デジタルツインにリアルな風景を
nagix
1
200
国土交通省 データコンペ参加者向け勉強会
takehikohashimoto
0
310
RAGのためのビジネス文書解析技術
eida
3
490
Forget efficiency – Become more productive without the stress
ufried
0
210
Spring Frameworkの新標準!? ~ RestClientとHTTPインターフェース入門 ~
ogiwarat
2
230
ZOZOTOWNでの推薦システム活用事例の紹介
f6wbl6
1
300
"君は見ているが観察していない"で考えるインシデントマネジメント
grimoh
3
750
【技術書典17】OpenFOAM(自宅で極める流体解析)2次元円柱まわりの流れ
kamakiri1225
0
260
DatabricksにおけるLLMOpsのベストプラクティス
taka_aki
4
1.5k
[JAWS-UG金沢支部×コンテナ支部合同企画]コンテナとは何か
furuton
3
330
SREの前に
nwiizo
9
1.4k
Featured
See All Featured
BBQ
matthewcrist
85
9.3k
Navigating Team Friction
lara
183
14k
A Modern Web Designer's Workflow
chriscoyier
693
190k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
32
1.8k
ピンチをチャンスに:未来をつくるプロダクトロードマップ #pmconf2020
aki_iinuma
108
49k
How to train your dragon (web standard)
notwaldorf
88
5.7k
Facilitating Awesome Meetings
lara
49
6.1k
Building an army of robots
kneath
302
42k
Six Lessons from altMBA
skipperchong
26
3.5k
Product Roadmaps are Hard
iamctodd
PRO
48
10k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
7
160
Optimizing for Happiness
mojombo
376
69k
Transcript
APIs An exploration into the past, present, and future parts
of web microservice and their place in current modern tech culture.
APIs What is an API?
Why APIs?
Mobile Devices
JS Frameworks
Email? SMS? Twitter?
Me
Jesse Wolgamott • Former Instructor, Back-End Engineer at TIY Houston
• Currently: Director, Back-end Engineering, The Iron Yard • Developer since 1997 • First JSON API: 2002
History
History, Quickly • API: “Application Programming Interface” • Standard input/output
for a library to be used and re-used • Computers have APIs (BIOS, Hard Drives, Operating Systems)
History, Quickly • Software worked over the “network” before the
internet • They would connect via “APIs” to a remote server. • Known as “Client/Server”
History, Quickly • The “internet” resembled this • People said,
let’s expose “data” over the internet via an “API” • It stuck
API Requests • There’s no difference between your browser requesting
facebook.com and a computer program making an “API” call • facebook.com might return HTML to your browser and JSON to the program
Headers • Both requests and responses contain “headers” • Headers
are sent/received with all requests/responses • They help browsers and computers do their thing
The Request
It’s called a Request no matter if you are requesting
data or sending data
Requests • URL • Method • Content-Type • Accepts
URL http://www.domain.com/users/56 Protocol Domain Path Resource ID
URL • Each “Entity” has one specific URL. • The
best URLs are “guessable”
Method • Each Request has an HTTP-Method • GET ->
request data • POST -> here’s new (or updated) data • DELETE -> delete data at this URL • PATCH -> here’s what to update
Content Type • Specified via a “HEADER” • When sending
data (POST/PATCH), tells server if you’re sending JSON or XML or JWOML
Accept • Specified via a “HEADER” • Tells server what
type of data you want to receive back, such as JSON, XML, or JWOML
The Response
Status Code • Specified via a “HEADER” • Tells the
client all sorts of things
OK Status Codes • 200: OK • 201: Created •
301: Over there (always) • 302: Over there (temporarily)
NotGreat Status Codes • 400: Generic Bad, but your bad
• 401: You are not authenticated • 404: Not Found • 422: Errors found in your data
RealBad Status Codes • 500: Big huge problem, it’s my
fault • 503: Service is down
General Status Codes • 200: OK • 300: Over There
• 400: [BLEEP] You • 500: [BLEEP] Me
Shape of Data • Each server will return different shapes
of data • This is dependent of whatever developer happened to code that one day they were employed there
Shape of Data • You have to exactly know the
shape of data to get anything of value out of the API • You won’t know the shape of data until making calls and manually looking at data
Exchange Rates response.rates.AUD
GitHub Repos [0].owner.login
JSON API Sample data[0].attributes.title
Shape of Data • Sometimes the base object is a
key, sometimes it’s an array • When you get this wrong, it brakes
Tools
Without JSON-View Formats JSON in Browsers
With JSON-View Formats JSON in Browsers
Postman Set headers, post data, receive data
Essential Tools • You have to exactly know the shape
of data to get anything of value out of the API • You won’t know the shape of data until making calls and manually looking at data • Sometimes you get documentation • Sometimes documentation is out of date
Authentication
Authentication Who You are
Authentication What App Are You Using?
User Authentication • User Authorization: Trade username and password for
a token • All requests then contain token. • Without request, 401 • Token can be in Header or a URL parameter.
App Authentication • Each App is given a token to
use for the App itself • ApiToken is usually a Header, but can also be a URL parameter
Authorization \What You Can See
Oauth
Way for Internet users to authorize websites or applications to
access their information on other websites but without giving them the passwords.
Way for Internet users to authorize websites or applications to
access their information on other websites but without giving them the passwords.
Two Types • Password Grant - used for me to
trade my username/password on a site for an auth token • Sign in with Facebook / Google / Spotify / GitHub, etc
It’s Just That Easy™
Oauth Difficulty • Difficult to get the “Connect” oauth right
• It is also the only responsible way to get a user’s information to your site from a second site
Standards (attempts)
JSON-API • Created by the EmberJS team, JSON-API attempts to
standardize the shape of the JSON responses • Results outside of Ember: not-great
GraphQL • “Hot Future” of JSON-APIs. • Query for what
you want, instead of returning ALL data.
PRO Tips
CORS • Helps protect information • Feels like it gets
in your way • If API protects against CORS, you use a server-side proxy to get around
JSON-P • Can cross CORS boundary • You specify a
callback to be called by server • (I’d rather just have a proxy)
More Logging • console.log() the response you actually get •
Don’t assume documentation is up to date, accurate, or nice
Great APIs Have
Great Expectations • Versioning • API Keys • Runnable Documentation
• Sample Libraries • Does just about what you’d expect
Publishing APIs
Microservices • JavaScript: Express, KOA, HAPI • Ruby: Sinatra •
C#: Nancy • Swift: Taylor
Larger Frameworks • Node: Adonis • Ruby: Rails • C#:
ASP.NET MVC • Swift: Vapor / Perfect