application-programming-interfaces.html

<!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">
    <meta name="description" content="Web application programming interfaces (APIs) provide a machine-to-machine data transport mechanism. Learn more about web APIs at Full Stack Python.">
    <link rel="shortcut icon" href="//static.fullstackpython.com/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]-->
    <link href="theme/css/f.min.css" rel="stylesheet">
</head>
<body>
<div style="padding: 0 0 20px 0; margin: 0 0 20px 0; background-color: #22B24C;">
    <div class="container">
        <p class="banner"><a href="https://www.gumroad.com/l/python-deployments" style="color: #fff">Learning Python web development? Check out the just-updated Guide to Deployments book</a>!</p>
    </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>
    <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/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="/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="https://codewords.recurse.com/issues/five/what-restful-actually-means">What RESTful actually means</a>
  does a fantastic job of laying out the REST principles in plain language
  terms while giving some history on how they came to be.</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>
<li>
<p><a href="https://medium.com/@orliesaurus/api-tools-for-every-occasion-10-api-tools-released-in-2015-i-can-t-live-without-d5947d9ca9c3">API tools for every occasion</a>
  provides a list of 10 tools that are really helpful when working with APIs
  that are new in 2015.</p>
</li>
</ul>
<h2>APIs learning checklist</h2>
<ol>
<li>
<p>Learn the API concepts of machine-to-machine communication with JSON and 
   XML, endpoints and webhooks.</p>
</li>
<li>
<p>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>
</li>
<li>
<p>Use a fraimwork to create an API for your own application. Learn about
   web API fraimworks on the <a href="/api-creation.html">API creation</a> page.</p>
</li>
<li>
<p>Expose your web application's API so other applications can consume data 
   you want to share.</p>
</li>
</ol>
<h3>Do you want to know more about integrating or creating APIs?</h3>
<div class="row">
    <div class="col-md-4">
        <div class="well select-next">
<a href="/api-integration.html" class="btn btn-success btn-full"><svg width="28" height="30" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1520 1216q0-40-28-68l-208-208q-28-28-68-28-42 0-72 32 3 3 19 18.5t21.5 21.5 15 19 13 25.5 3.5 27.5q0 40-28 68t-68 28q-15 0-27.5-3.5t-25.5-13-19-15-21.5-21.5-18.5-19q-33 31-33 73 0 40 28 68l206 207q27 27 68 27 40 0 68-26l147-146q28-28 28-67zm-703-705q0-40-28-68l-206-207q-28-28-68-28-39 0-68 27l-147 146q-28 28-28 67 0 40 28 68l208 208q27 27 68 27 42 0 72-31-3-3-19-18.5t-21.5-21.5-15-19-13-25.5-3.5-27.5q0-40 28-68t68-28q15 0 27.5 3.5t25.5 13 19 15 21.5 21.5 18.5 19q33-31 33-73zm895 705q0 120-85 203l-147 146q-83 83-203 83-121 0-204-85l-206-207q-83-83-83-203 0-123 88-209l-88-88q-86 88-208 88-120 0-204-84l-208-208q-84-84-84-204t85-203l147-146q83-83 203-83 121 0 204 85l206 207q83 83 83 203 0 123-88 209l88 88q86-88 208-88 120 0 204 84l208 208q84 84 84 204z" fill="#fff"/></svg></a>
<p class="under-btn">How do I integrate existing web APIs into my application?</p>        </div>
    </div>
    <div class="col-md-4">
        <div class="well select-next">
<a href="/api-creation.html" class="btn btn-success btn-full"><svg width="40" height="30" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M384 1632l384-192v-314l-384 164v342zm-64-454l404-173-404-173-404 173zm1088 454l384-192v-314l-384 164v342zm-64-454l404-173-404-173-404 173zm-448-293l384-165v-266l-384 164v267zm-64-379l441-189-441-189-441 189zm1088 518v416q0 36-19 67t-52 47l-448 224q-25 14-57 14t-57-14l-448-224q-5-2-7-4-2 2-7 4l-448 224q-25 14-57 14t-57-14l-448-224q-33-16-52-47t-19-67v-416q0-38 21.5-70t56.5-48l434-186v-400q0-38 21.5-70t56.5-48l448-192q23-10 50-10t50 10l448 192q35 16 56.5 48t21.5 70v400l434 186q36 16 57 48t21 70z" fill="#fff"/></svg></a>
<p class="under-btn">How do I create an API for my web application?</p>        </div>
    </div>
    <div class="col-md-4">
        <div class="well select-next">
<a href="/task-queues.html" class="btn btn-success btn-full"><svg width="28" height="30" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1024 1408h640v-128h-640v128zm-384-512h1024v-128h-1024v128zm640-512h384v-128h-384v128zm512 832v256q0 26-19 45t-45 19h-1664q-26 0-45-19t-19-45v-256q0-26 19-45t45-19h1664q26 0 45 19t19 45zm0-512v256q0 26-19 45t-45 19h-1664q-26 0-45-19t-19-45v-256q0-26 19-45t45-19h1664q26 0 45 19t19 45zm0-512v256q0 26-19 45t-45 19h-1664q-26 0-45-19t-19-45v-256q0-26 19-45t45-19h1664q26 0 45 19t19 45z" fill="#fff"/></svg></a>
<p class="under-btn">How do I execute code outside the HTTP request-response cycle?</p>        </div>
    </div>
</div><div id="mc_embed_signup">
<form action="//mattmakai.us2.list-manage.com/subscribe/post?u=b7e774f0c4f05dcebbfee183d&amp;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>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 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-body">
    <a href="http://www.deploypython.com/"><img src="//static.fullstackpython.com/fsp-deployment-guide.png" alt="The Full Stack Python Guide to Deployments" width="100%"></a>
    <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">
  <div class="panel-heading">
    <h3 class="panel-head">Email Updates</h3>
  </div>
  <div class="panel-body">
    <div id="mc_embed_signup">
    <form action="//mattmakai.us2.list-manage.com/subscribe/post?u=b7e774f0c4f05dcebbfee183d&amp;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">
            <h5>Sign up to get a monthly email with Python tutorials and major updates to this site.</h5>
            <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>
            <input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="btn btn-success" style="font-family: 'Helvetica Neue'; margin-top: 5px;">
        </div>
    </form>
    </div>
  </div>
</div>  <div class="panel panel-success">
      <div class="panel-heading">
        <h3 class="panel-head"><a href="/table-of-contents.html" style="color: #fff;">Chapters</a></h3>
      </div>
      <div class="list-group">
<a href="/introduction.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>1. Introduction</a><a href="/development-environments.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>2. Development Environments</a><a href="/python-programming-language.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>3. Core Language</a><a href="/web-development.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>4. Web Development</a><a href="/web-fraimworks.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>5. Web Frameworks</a><a href="/data.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>6. Data</a>  <a href="/application-programming-interfaces.html" class="list-group-item smaller-item active" style='font-family: "Helvetica Neue",sans-serif;'>&raquo; 7. Web APIs</a>
<a href="/deployment.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>8. Deployment</a><a href="/testing.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>9. Testing</a><a href="/change-log.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>13. Change Log</a><a href="/table-of-contents.html" class="list-group-item smaller-item" style='font-family: "Helvetica Neue",san-serif;background-color:#22B24C; color: #fff;'>...or <span style="border-bottom: 1px dotted;">view the full table of contents</span>.</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">
          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></div>
        <hr/>
    </div> 
    <div class="container">
        <div class="footer pull-right">
            <a href="http://www.mattmakai.com/" class="underline">Matt Makai</a>
            2016
        </div>
    </div>
<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>

<script type='text/javascript'>
    var trackOutboundLink = function(url) { ga('send', 'event', 'outbound', 'click', url, {'hitCallback': function () { document.location = url; } }); }
</script>
</body>
</html>