The Non-Coder’s Information to The use of the Lend a hand Scout API to api.png?ixlib=gatsbySourceUrl 2.1

After I first got to work in give a boost to, APIs — the Utility Programming Interfaces that attach technical merchandise — have been a frightening unknown. They concerned code, and I’m no developer, so certainly they have been past my comprehension.

Then I wound up being employed to give a boost to a product that used to be fully APIs. I came upon that with somewhat effort, I may learn to use them, and you’ll be able to, too.

APIs are simply the precise phrases servers use to inform different device what to do. If you’ll be able to lend a hand the ones inconsistent and wildly undocumented people get issues completed with device, you’ll be able to do the similar for a pleasing predictable pc.

Underneath, you’ll see a video walkthrough of the Lend a hand Scout Mailbox API. Even though you’ve by no means used an API sooner than, we’ll have you ever up and working sooner than you comprehend it.

This video is for give a boost to other people who’re concerned about finding out learn how to get began the use of an API. You don’t want to be pleased with code or the command line to be triumphant.

If you wish to practice at the side of the video precisely, you’ll need 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 reproduction 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 practice Postman’s wisdom base on learn how to import the calls.

If you happen to paintings via this video, you’re going to:

  • Perceive what an API is.

  • Understand how a RESTful JSON API works.

  • Be capable of use our API to drag your personal information.

  • Have subsequent steps to be informed extra about APIs.

Notes at the video

All through the video, you’ll see me make API calls with the next endpoints, the use of our API documentation:

The ones calls quilt the total vary of HTTP verbs that Lend a hand 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 current useful resource by means of including new information

  • PUT — To replace an current useful resource by means of overwriting current information

  • DELETE — To delete an current useful resource

Subsequent steps

If this video were given you enthusiastic about doing extra with the Lend a hand Scout API, we advise this Glitch app as a kick off point. Glitch is a internet app for sharing and dealing on different internet apps. Bob Stalmach, one among our Lend a hand 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 root to your personal app that makes use of our API.

If you happen to’d like to be informed extra about APIs normally, we now have some suggestions:

Finding out to know and use APIs will let you ship higher carrier in your shoppers and might open up new choices to your occupation and your individual initiatives. When you find yourself construction one thing of your personal the use of our API, please tell us. We’d love to peer it!

Leave a Reply

Your email address will not be published. Required fields are marked *