API workshop

Preparations

• Download and install the POSTman app.
• Create a 46elks account.

Why and when use APIs?

• Open up access to data
• Automation - access to systems
• Layer on top of complexity

Be brave!

You’ll encounter terminology and abbreviations that make no sense, and that’s ok!

Terminology

• url
• request
• response
• status codes
• docs
• GET & POST
• Authentication
• format (json, xml, other)
• Open data

Summary

• URL The address. You have a home address.
  The API has its home address on the internet. Just like websites.
  Example: https://api.46elks.com/a1/SMS
• Request
  • GET Ask for data.
  • POST Send in data. Trigger an event.
• Status codes
  • 200 All is well.
  • 404 Can't find what you're looking for!
  • 20x OK!
  • 30x Somewhere else!
  • 40x You're not doing it right.
    Check the documentation/manual/instruction. Ask for help!
    Example: https://46elks.com/thispagedoesnotexist - 404.
  • 50x We made a mistake! Perhaps you might want to let us know! Or try again later!
  • http cat
• Format
  • json
    • [ list, with, values ]
    • { key: "value", other_key: "different value"}
  • XML
    • <key>value</key> <other_key>different value</other_key>
• Authentication
  • Credentials
  • API key
  • Basic auth
• Code examples

  import requests
  
  requests.post(
      "https://api.46elks.com/a1/SMS",
      auth = (API_USERNAME, API_PASSWORD),
      data = {
          "from": "ElkCo",
          "to": "+46766861004",
          "message": "It's cold outside, bring a sweater!"
      }
  )