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
160
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
87
DIY Rails Authentication
jwo
0
180
ActionCable - For Not Another Chat App
jwo
3
1.3k
SlackBot.rb - Create You a Slack Bot
jwo
1
1.2k
react-rails: an isomorphic match made in heaven
jwo
0
1.1k
Docker - next big thing
jwo
0
780
Ruby 2.1 Overview
jwo
0
790
Rails 4: Appetizers
jwo
1
800
The Long Ball: Upgrading Rails from 1.2 -> 4.0
jwo
2
180
Other Decks in Technology
See All in Technology
Datadog Cloud SIEMを使ってAWS環境の脅威を可視化した話/lifeistech-datadog-cloud-siem
gidajun
0
480
テストケースの自動生成に生成AIの導入を試みた話と生成AIによる今後の期待
shift_evolve
0
190
データベース研修 DB基礎【MIXI 24新卒技術研修】
mixi_engineers
PRO
0
220
E2Eテスト自動化プラットフォームにおけるAIの活用
shift_evolve
0
190
Github Actions 로 Android 팀의 효율성 극대화
hadonghyun
0
160
データベース研修 分析向けSQL入門【MIXI 24新卒技術研修】
mixi_engineers
PRO
0
110
公共領域から学ぶ クラウド移行についてエンジニアが意識していること
kawakawa2222
0
140
シフトレフトで挑む セキュリティの生産性向上
sekido
PRO
0
270
目標設定は好きですか? アジャイルとともに目標と向き合い続ける方法 / Do you like target Management?
kakehashi
10
3k
クラウド利用者の「責任」をどう果たす?AWSセキュリティ対策のススメ #AWSSummit
hiashisan
0
280
AWS IAMのアンチパターン/AWSが考える最低権限実現へのアプローチ概略(JAWS-UG朝会#59資料改修20分版)
htan
0
330
サーバーレスAPI(API Gateway+Lambda)とNext.jsで 個人ブログを作ろう!
shuntaka
PRO
0
560
Featured
See All Featured
How to train your dragon (web standard)
notwaldorf
79
5.5k
Building Applications with DynamoDB
mza
89
5.8k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
34
1.9k
What the flash - Photography Introduction
edds
65
11k
Code Review Best Practice
trishagee
58
16k
Leading Effective Engineering Teams 2024
addyosmani
3
300
Teambox: Starting and Learning
jrom
130
8.6k
GitHub's CSS Performance
jonrohan
1026
450k
Designing for humans not robots
tammielis
247
25k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
26
1.8k
Why You Should Never Use an ORM
jnunemaker
PRO
51
8.9k
Fight the Zombie Pattern Library - RWD Summit 2016
marcelosomers
228
16k
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