fullstackpython.com/api-integration.html at patch-1 · nullism/fullstackpython.com · GitHub

History

289 lines (288 loc) · 21.4 KB

Raw

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

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

<!DOCTYPE html>

<head>

<title>API Integration - Full Stack Python</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<body>

<h2 style="color: #fff; margin: 20px 40px 0 0;"><a href="https://www.gumroad.com/l/python-deployments" style="color: #fff">The Full Stack Python Guide to Deployments book</a> has been released!</h2>

</div>

</div> <a href="https://github.com/makaimc/fullstackpython.com"><img style="position: absolute; top: 0; right: 0; border: 0;" src="/theme/img/fork.png" alt="Fork me on GitHub"></a>

<span class="logo-title"><a href="/">Full Stack Python</a></span>

</div>

</div><div class="row">

<h1>API Integration</h1>

<p>The majority of production Python web applications rely on several

externally hosted application programming interfaces (APIs). APIs are also

commonly referred to as third party services or external platforms.

Examples include <a href="https://www.twilio.com/docs/">Twilio</a> for messaging and

voice services, <a href="https://stripe.com/docs/api">Stripe</a> for payment processing

and <a href="https://disqus.com/api/docs/">Disqus</a> for embedded webpage comments.</p>

<p>There are many articles about proper API design but best practices for

integrating APIs is less commonly written about. However, this subject

continuously grows in importance because APIs provide critical functionality

across many implementation areas.</p>

<h2>Hosted API testing services</h2>

<ul>

<li>

<p><a href="https://www.runscope.com/">Runscope</a> is a service specifically designed

for APIs that assists developers with automated testing and traffic

inspection.</p>

</li>

<li>

<p><a href="http://apiary.io/">Apiary</a> provides a blueprint for creating APIs so

they are easier to test and generate clean documentation.</p>

</li>

</ul>

<h2>API Integration Resources</h2>

<ul>

<li>

<p>Some developers prefer to use

<a href="http://docs.python-requests.org/en/latest/">Requests</a> instead of an API's

helper library. In that case check out this

<a href="http://engineering.hackerearth.com/2014/08/21/python-requests-module/">tutorial on using requests to access web APIs</a>.</p>

</li>

<li>

<p>There's a list of all government web APIs at

<a href="http://18f.github.io/API-All-the-X/">18F's API-All-the-X list</a>. The list

is updated whenever a new API comes online.</p>

</li>

<li>

<p>If you use Requests check out this handy guide on gracefully

<a href="http://www.mobify.com/blog/http-requests-are-hard/">handling HTTP errors with Python</a>.</p>

</li>

<li>

<p>John Sheehan's

"<a href="https://speakerdeck.com/johnsheehan/zen-and-the-art-of-api-maintenance">Zen and the Art of API Maintenance</a>"

slides are relevant for API integration.</p>

</li>

<li>

<p>This post on

"<a href="https://stormpath.com/blog/api-driven-development/">API Driven Development</a>"

by Randall Degges explains how using APIs in your application cuts down

on the amount of code you have to write and maintain so you can launch your

application faster.</p>

</li>

<li>

<p><a href="http://www.slideshare.net/SmartBear_Software/safe-sex-with-thirdparty-apis">Safe Sex with Third Party APIs</a>

is a funny high level overview of what you should do to protect your

application when relying on third party services.</p>

</li>

<li>

<p><a href="http://www.coglib.com/~icordasc/blog/2014/12/retries-in-requests.html">Retries in Requests</a>

is a nice tutorial for easily re-executing failed HTTP requests with the

Requests library.</p>

</li>

<li>

<p>My DjangoCon 2013 talk dove into

"<a href="http://www.youtube.com/watch?v=iGP8DQIqxXs">Making Django Play Nice With Third Party Services</a>."</p>

</li>

<li>

<p>If you're looking for a fun project that uses two web APIs within a

Django application, try out this tutorial to

<a href="https://www.twilio.com/blog/2014/11/build-your-own-pokedex-with-django-mms-and-pokeapi.html">Build your own Pokédex with Django, MMS and PokéAPI</a>.</p>

</li>

<li>

is a way to capture and replay HTTP requests with mocks. It's extremely

useful for testing API integrations.</p>

</li>

<li>

<p><a href="https://realpython.com/blog/python/caching-external-api-requests/">Caching external API requests</a>

is a good post on how to potentially limit the number of HTTP calls

required when accessing an external web API via the Requests library.</p>

</li>

</ul>

<h2>API integration learning checklist</h2>

<ol>

<li>

<p>Pick an API known for top notch documentation. Here's a list of

<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>

</li>

<li>

<p>Read the API documentation for your chosen API. Figure out a simple

use case for how your application could be improved by using that API.</p>

</li>

<li>

<p>Before you start writing any code, play around with the API through the

commandline with <a href="http://curl.haxx.se/">cURL</a> or in the browser with

<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get

a better understanding of API authentication and the data required for

requests and responses.</p>

</li>

<li>

<p>Evaluate whether to use a helper library or work with

<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries

are usually easier to get started with while Requests gives you more

control over the HTTP calls.</p>

</li>

<li>

<p>Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not

block the HTTP request-response cycle for your web application.</p>

</li>

</ol>

<h3>What's next after integrating web APIs into your project?</h3>

<p class="under-btn">How do I create an API for my web application?</p> </div>

</div>

<p class="under-btn">How do I log errors that occur in my application?</p> </div>

</div>

<p class="under-btn">What can I do to mitigate security vulnerability in my web app?</p> </div>

</div>

</div><div id="mc_embed_signup">

<h4>Sign up here to receive an email with major updates to this site and Python tutorials delivered to your inbox once a month.</h4>

</div>

</div>

</form>

</div>

<p style="font-size: .8em; margin-top: 10px;">Searching for a complete, step-by-step deployment walkthrough? Learn more about <a href="http://www.deploypython.com/">The Full Stack Python Guide to Deployments book</a>.

</p>

</div>

</div> <div class="panel panel-success">

<h3 class="panel-head"><a href="/table-of-contents.html" style="color: #fff;">Table of Contents</a></h3>

</div>

<a href="/introduction.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Introduction</a>

<a href="/learning-programming.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Learning Programming</a>

<a href="/why-use-python.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Why Use Python?</a>

<a href="/python-2-or-3.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Python 2 or 3?</a>

<a href="/enterprise-python.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Enterprise Python</a>

<a href="/best-python-resources.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Best Python Resources</a>

<a href="/best-python-videos.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Best Python Videos</a>

<a href="/development-environments.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Development Environments</a>

<a href="/emacs.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Emacs</a>

<a href="/generators.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Generators</a>

<a href="/comprehensions.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Comprehensions</a>

<a href="/web-frameworks.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Frameworks</a>

<a href="/django.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Django</a>

<a href="/flask.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Flask</a>

<a href="/bottle.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Bottle</a>

<a href="/pyramid.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Pyramid</a>

<a href="/morepath.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Morepath</a>

<a href="/other-web-frameworks.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Other Web Frameworks</a>

<a href="/web-design.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Design</a>

<a href="/cascading-style-sheets.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Cascading Style Sheets</a>

<a href="/javascript.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>JavaScript</a>

<a href="/websockets.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>WebSockets</a>

<a href="/web-application-security.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Application Security</a>

<a href="/static-site-generator.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Static Site Generators</a>

<a href="/databases.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Databases</a>

<a href="/no-sql-datastore.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>NoSQL Data Stores</a>

<a href="/object-relational-mappers-orms.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Object-relational Mappers (ORMs)</a>

<a href="/application-programming-interfaces.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Application Programming Interfaces</a>

<a href="/api-integration.html" class="list-group-item smaller-item active" style='font-family: "Helvetica Neue",sans-serif;'>API Integration</a>

<a href="/api-creation.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>API Creation</a>

<a href="/deployment.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Deployment</a>

<a href="/servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Servers</a>

<a href="/platform-as-a-service.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Platform-as-a-service</a>

<a href="/operating-systems.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Operating Systems</a>

<a href="/web-servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Servers</a>

<a href="/wsgi-servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>WSGI Servers</a>

<a href="/source-control.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Source Control</a>

<a href="/application-dependencies.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Application Dependencies</a>

<a href="/static-content.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Static Content</a>

<a href="/task-queues.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Task Queues</a>

<a href="/configuration-management.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Configuration Management</a>

<a href="/continuous-integration.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Continuous Integration</a>

<a href="/logging.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Logging</a>

<a href="/monitoring.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Monitoring</a>

<a href="/web-analytics.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Analytics</a>

<a href="/docker.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Docker</a>

<a href="/caching.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Caching</a>

<a href="/microservices.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Microservices</a>

<a href="/testing.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Testing</a>

<a href="/unit-testing.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Unit Testing</a>

<a href="/integration-testing.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Integration Testing</a>

<a href="/code-metrics.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Code Metrics</a>

<a href="/debugging.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Debugging</a>

<a href="/what-full-stack-means.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>What "Full Stack" Means</a>

<a href="/change-log.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Change Log</a>

<a href="/future-directions.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Future Directions</a>

<a href="/about-author.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>About the Author</a>

</div>

</p>

</div>

</div> <div class="panel panel-success">

<div class="panel-heading"><h3 class="panel-head">API Integration</h3></div>

Major updates are tweeted via

<a href="https://twitter.com/fullstackpython">@fullstackpython</a>.

<hr/>

Need more detailed tutorials than you see here?

<a href="http://www.deploypython.com/">Learn more about The Full Stack Python Guide to Deployments book.</a>

</div>

</div></div>

<hr/>

</div>

<a href="http://www.mattmakai.com/" class="underline">Matt Makai</a>

2015

</div>

(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>

var trackOutboundLink = function(url) { ga('send', 'event', 'outbound', 'click', url, {'hitCallback': function () { document.location = url; } }); }

</script>

</body>

</html>

fullstackpython.com/api-integration.html at patch-1 · nullism/fullstackpython.com · GitHub

Expand file tree

Breadcrumbs

api-integration.html

Latest commit

History

Breadcrumbs

api-integration.html

File metadata and controls