forked from mattmakai/fullstackpython.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapplication-programming-interfaces.html
More file actions
241 lines (240 loc) · 14.3 KB
/
Copy pathapplication-programming-interfaces.html
File metadata and controls
241 lines (240 loc) · 14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE html>
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Matt Makai">
<link rel="shortcut icon" href="theme/img/fsp-fav.png">
<title>Application Programming Interfaces - Full Stack Python</title>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<style>
.toc-indent {padding-left: 25px;}
.toc-more-indent {padding-left: 37px;}
</style>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-19910497-7', 'auto');
ga('send', 'pageview');
</script> </head>
<body>
<a href="https://github.com/makaimc/fullstackpython.github.com"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
<div class="container">
<div class="row">
<div class="col-md-12">
<div class="logo-header-section">
<a href="/" style="text-decoration: none; border: none;"><img src="theme/img/fsp-logo.png" height="52" width="52" class="logo-image" style="padding-top: 1px;" alt="Full Stack Python logo"></a>
<span class="logo-title"><a href="/">Full Stack Python</a></span>
</div>
</div>
</div><div class="row">
<div class="col-md-8">
<h1>Application Programming Interfaces</h1>
<p>Application programming interfaces (APIs) provide machine-readable
data transfer and signaling between applications.</p>
<h2>Why are APIs important?</h2>
<p>HTML, CSS and JavaScript create human-readable webpages. However, those
webpages are not easily consumable by other machines.</p>
<p>Numerous scraping programs and libraries exist to rip data out of HTML but
it's simpler to consume data through APIs. For example, if you want the
content of a news article it's easier to get the content through an API than
to scrap the text out of the HTML.</p>
<h2>Key API concepts</h2>
<p>There are several key concepts that get thrown around in the APIs world. It's
best to understand these ideas first before diving into the API literature.</p>
<ul>
<li>
<p>Representation State Transfer (REST)</p>
</li>
<li>
<p>Webhooks</p>
</li>
<li>
<p>JavaScript Object Notation (JSON) and Extensible Markup Language (XML)</p>
</li>
<li>
<p>Endpoints</p>
</li>
</ul>
<h2>Webhooks</h2>
<p>A webhook is a user-defined HTTP callback to a URL that executes when a
system condition is met. The call alerts the second system via a POST or GET
request and often passes data as well.</p>
<p>Webhooks are important because they enable two-way communication initiation
for APIs. Webhook flexibility comes in from their definition by the API user
instead of the API itself.</p>
<p>For example, in the <a href="https://www.twilio.com/api">Twilio API</a> when a text
message is sent to a Twilio phone number Twilio sends an HTTP POST request
webhook to the URL specified by the user. The URL is defined in a text box
on the number's page on Twilio as shown below.</p>
<p><img src="theme/img/twilio-webhook-definition.jpg" width="100%" alt="Webhook definition in the Twilio API." class="technical-diagram" /></p>
<h2>API open source projects</h2>
<ul>
<li><a href="https://github.com/wordnik/swagger-core">Swagger</a> is an open source project
written in Scala that defines a standard interface for RESTful APIs.</li>
</ul>
<h2>API resources</h2>
<ul>
<li>
<p><a href="https://zapier.com/">Zapier</a> has an
<a href="https://zapier.com/blog/apis-101/">APIs 101</a> free guide for what APIs
are, why they are valuable and how to use them properly. </p>
</li>
<li>
<p><a href="http://sendgrid.com/blog/whats-webhook/">What is a webhook?</a> by
<a href="https://twitter.com/YayNickQ">Nick Quinlan</a> is a plain English explanation
for what webhooks are and why they are necessary in the API world.</p>
</li>
<li>
<p><a href="http://keithba.net/simplicity-and-utility-or-why-soap-lost">Simplicity and Utility, or, Why SOAP Lost</a>
provides context for why JSON-based web services are more common today than
SOAP which was popular in the early 2000s.</p>
</li>
</ul>
<h2>APIs learning checklist</h2>
<p><i class="fa fa-check-square-o"></i>
Learn the API concepts of machine-to-machine communication with JSON and XML,
endpoints and webhooks.</p>
<p><i class="fa fa-check-square-o"></i>
Integrate an API such as Twilio or Stripe into your web application. Read the
<a href="/api-integration.html">API integration</a> section for more information.</p>
<p><i class="fa fa-check-square-o"></i>
Use a framework to create an API for your own application. </p>
<p><i class="fa fa-check-square-o"></i>
Expose your web application's API so other applications can consume data you
want to share.</p>
<h3>What's next after learning about APIs?</h3>
<div class="row">
<div class="col-md-3">
<div class="well select-next">
<a href="/api-integration.html" class="btn btn-success btn-full"><i class="fa fa-link fa-2x"></i></a>
<p class="under-btn">
How do I integrate external APIs into my application?
</p>
</div>
</div>
<div class="col-md-3">
<div class="well select-next">
<a href="/task-queues.html" class="btn btn-success btn-full"><i class="fa fa-tasks fa-2x"></i></a>
</a>
<p class="under-btn">
How can I invoke APIs outside the HTTP request-response cycle?
</p>
</div>
</div>
<div class="col-md-3">
<div class="well select-next">
<a href="/web-application-security.html" class="btn btn-success btn-full"><i class="fa fa-lock fa-inverse fa-2x"></i></a>
<p class="under-btn">
Where can I learn about web application security?
</p>
</div>
</div>
<div class="col-md-3">
<div class="well select-next">
<a href="/api-creation.html" class="btn btn-success btn-full"><i class="fa fa-cubes fa-2x"></i></a>
<p class="under-btn">
How do I create an API for my own web application?
</p>
</div>
</div>
</div> <div id="mc_embed_signup">
<form action="//mattmakai.us2.list-manage.com/subscribe/post?u=b7e774f0c4f05dcebbfee183d&id=b22335388d" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
<div id="mc_embed_signup_scroll">
<h4>Interested in major updates to this site or an alert when a complete Full Stack Python book with detailed example code is released? Sign up here and you'll an occasional email only when there's big news to report.</h4>
<div class="row">
<div class="col-md-9">
<input type="email" value="" name="EMAIL" class="email form-control" id="mce-EMAIL" placeholder="email address" required>
<div style="position: absolute; left: -5000px;"><input type="text" name="b_b7e774f0c4f05dcebbfee183d_b22335388d" tabindex="-1" value=""></div>
</div>
<div class="col-md-3">
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="btn btn-success" style="font-family: 'Helvetica Neue';"></div>
</div>
</div>
</div>
</form>
</div>
</div>
<div class="col-md-offset-1 col-md-3" id="sidebar">
<div class="panel panel-success">
<div class="panel-heading">
<h3 class="panel-head"><a href="/table-of-contents.html" style="color: #fff;">Table of Contents</a></h3>
</div>
<div class="list-group">
<a href="/introduction.html" class="list-group-item smaller-item ">Introduction</a>
<a href="/web-frameworks.html" class="list-group-item smaller-item ">Web Frameworks</a>
<a href="/django.html" class="list-group-item smaller-item ">Django</a>
<a href="/flask.html" class="list-group-item smaller-item ">Flask</a>
<a href="/vim.html" class="list-group-item smaller-item ">Vim</a>
<a href="/bottle.html" class="list-group-item smaller-item ">Bottle</a>
<a href="/morepath.html" class="list-group-item smaller-item ">Morepath</a>
<a href="/other-web-frameworks.html" class="list-group-item smaller-item ">Other Web Frameworks</a>
<a href="/deployment.html" class="list-group-item smaller-item ">Deployment</a>
<a href="/servers.html" class="list-group-item smaller-item ">Servers</a>
<a href="/platform-as-a-service.html" class="list-group-item smaller-item ">Platform-as-a-service</a>
<a href="/operating-systems.html" class="list-group-item smaller-item ">Operating Systems</a>
<a href="/web-servers.html" class="list-group-item smaller-item ">Web Servers</a>
<a href="/wsgi-servers.html" class="list-group-item smaller-item ">WSGI Servers</a>
<a href="/source-control.html" class="list-group-item smaller-item ">Source Control</a>
<a href="/application-dependencies.html" class="list-group-item smaller-item ">Application Dependencies</a>
<a href="/databases.html" class="list-group-item smaller-item ">Databases</a>
<a href="/no-sql-datastore.html" class="list-group-item smaller-item ">NoSQL Data Stores</a>
<a href="/pyramid.html" class="list-group-item smaller-item ">Pyramid</a>
<a href="/web-design.html" class="list-group-item smaller-item ">Web Design</a>
<a href="/cascading-style-sheets.html" class="list-group-item smaller-item ">Cascading Style Sheets</a>
<a href="/javascript.html" class="list-group-item smaller-item ">JavaScript</a>
<a href="/continuous-integration.html" class="list-group-item smaller-item ">Continuous Integration</a>
<a href="/code-metrics.html" class="list-group-item smaller-item ">Code Metrics</a>
<a href="/configuration-management.html" class="list-group-item smaller-item ">Configuration Management</a>
<a href="/static-content.html" class="list-group-item smaller-item ">Static Content</a>
<a href="/caching.html" class="list-group-item smaller-item ">Caching</a>
<a href="/task-queues.html" class="list-group-item smaller-item ">Task Queues</a>
<a href="/application-programming-interfaces.html" class="list-group-item smaller-item active">Application Programming Interfaces</a>
<a href="/api-integration.html" class="list-group-item smaller-item ">API Integration</a>
<a href="/api-creation.html" class="list-group-item smaller-item ">API Creation</a>
<a href="/logging.html" class="list-group-item smaller-item ">Logging</a>
<a href="/monitoring.html" class="list-group-item smaller-item ">Monitoring</a>
<a href="/web-analytics.html" class="list-group-item smaller-item ">Web Analytics</a>
<a href="/web-application-security.html" class="list-group-item smaller-item ">Web Application Security</a>
<a href="/best-python-resources.html" class="list-group-item smaller-item ">Best Python Resources</a>
<a href="/development-environments.html" class="list-group-item smaller-item ">Development Environments</a>
<a href="/about-author.html" class="list-group-item smaller-item ">About the Author</a>
<a href="/change-log.html" class="list-group-item smaller-item ">Change Log</a>
<a href="/future-directions.html" class="list-group-item smaller-item ">Future Directions</a>
<a href="/what-full-stack-means.html" class="list-group-item smaller-item ">What "Full Stack" Means</a>
<a href="/why-use-python.html" class="list-group-item smaller-item ">Why Use Python?</a>
<a href="/websockets.html" class="list-group-item smaller-item ">WebSockets</a>
<a href="/docker.html" class="list-group-item smaller-item ">Docker</a>
</div>
</div>
<div class="panel panel-success">
<div class="panel-heading"><h3 class="panel-head">Application Programming Interfaces</h3></div>
<div class="panel-body">
Need more detailed tutorials and walkthroughs than you see here?
<a href="/email.html">Sign up for an email alert when that content is created.</a>
<hr/>
<a href="/">Full Stack Python</a> is an open book that explains
concepts in plain language and provides the most helpful resources
on those topics.
<hr/>
<a href="http://twitter.com/mattmakai">Matt Makai</a> built
this site with appreciated assistance from
<a href="https://github.com/makaimc/fullstackpython.github.com/pulls">pull requests</a>.
</div>
</div>
</div></div>
<hr/>
<div class="footer pull-right">
<a href="http://www.mattmakai.com/" class="underline">Matt Makai</a>
2015
</div>
</div>
<link href="theme/css/f.min.css" rel="stylesheet">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet">
</body>
</html>