Once I first got to work in give a boost to, APIs — the Software Programming Interfaces that attach technical merchandise — have been a frightening unknown. They concerned code, and I’m no developer, so definitely they have been past my comprehension.
Then I wound up being employed to give a boost to a product that was once totally APIs. I came upon that with just a little effort, I may just discover ways to use them, and you’ll be able to, too.
APIs are simply the precise phrases servers use to inform different tool what to do. If you’ll be able to assist the ones inconsistent and wildly undocumented people get issues executed with tool, you’ll be able to do the similar for a pleasing predictable pc.
Underneath, you’ll see a video walkthrough of the Assist Scout Mailbox API. Even supposing you’ve by no means used an API sooner than, we’ll have you ever up and operating sooner than you are aware of it.
This video is for give a boost to other people who’re concerned about studying find out how to get began the usage of an API. You don’t want to be pleased with code or the command line to be triumphant.
If you wish to apply in conjunction with the video precisely, you’ll wish to use Postman. Simply create a loose account and you’ll be able to employ any API via a pleasant, graphical interface, with easy-to-read responses.
To avoid wasting you a while, we’ve generated this number of instance API calls. You’ll replica and paste that textual content immediately into Postman (I’ll display you ways to do this within the video), or you’ll be able to apply Postman’s wisdom base on find out how to import the calls.
Should you paintings via this video, you are going to:
Perceive what an API is.
Know the way a RESTful JSON API works.
Be capable to use our API to tug your personal knowledge.
Have subsequent steps to be told extra about APIs.
Notes at the video
Throughout the video, you’ll see me make API calls with the next endpoints, the usage of our API documentation:
The ones calls duvet the overall vary of HTTP verbs that Assist Scout’s API makes use of:
GET — To turn details about a useful resource
POST — To create a brand-new useful resource
PATCH — To replace an present useful resource via including new knowledge
PUT — To replace an present useful resource via overwriting present knowledge
DELETE — To delete an present useful resource
Subsequent steps
If this video were given you interested by doing extra with the Assist Scout API, we propose this Glitch app as a place to begin. Glitch is a internet app for sharing and dealing on different internet apps. Bob Stalmach, certainly one of our Assist Scout Engineers, constructed a pattern app appearing how you’ll be able to embed API calls into your personal internet app.
You’ll “remix” his pattern app, upload your personal API token, and use that as the foundation to your personal app that makes use of our API.
Should you’d like to be told extra about APIs generally, we’ve got some suggestions:
Finding out to know and use APIs will can help you ship higher carrier on your shoppers and might open up new choices to your occupation and your individual tasks. When you’re construction one thing of your personal the usage of our API, please tell us. We’d love to look it!
