<!-- JSON-LD markup generated by Google Structured Data Markup Helper. --><script type="application/ld+json">[ {  "@context" : "http://schema.org",  "@type" : "Article",  "name" : "How technical are APIs?",  "author" : {    "@type" : "Person",    "name" : "Shripati Bhat"  },  "image" : "https://global-uploads.webflow.com/5ef788f07804fb7d78a4127a/6051f50617bfaa20c39bcc23_How-APIs-work.png",  "articleBody" : "Just like how every language has grammar, syntaxes, and dos and don&#39;ts, communication between systems has its own set of rules. Let&#39;s look at the details of the parts of speech/grammar equivalence for a REST API.",  "publisher" : {    "@type" : "Organization",    "name" : "Engati"  }}, {  "@context" : "http://schema.org",  "@type" : "Article",  "name" : "How technical are APIs?",  "author" : {    "@type" : "Person",    "name" : "Shripati Bhat"  },  "image" : "https://global-uploads.webflow.com/5ef788f07804fb7d78a4127a/6051f4cec11c0917691a2fd3_cxqRB8aOycnYYqC9BbzsNOpOV0Oio2iA04UAR2dPsFyjSsGS-_BX9FPcxgYMOhSncUu0OU0kHDUW4sD2XInzJ7L4HvC6gz266RHMVjzSXo9sTEAE3j-BGdv3AFYJEz_zRZp0WwCs.png",  "articleBody" : "Going back to our example of Engati attempting to create a ticket in the ticketing system, that is a create operation. Hence Engati will have to invoke a REST API in the ticketing system. To invoke the API, you would need to know the parts of speech/grammar equivalence, i.e., the URL, Parameters, Request Type (which ideally should be POST), Request Body.",  "publisher" : {    "@type" : "Organization",    "name" : "Engati"  }}, {  "@context" : "http://schema.org",  "@type" : "Article",  "name" : "How technical are APIs?",  "author" : {    "@type" : "Person",    "name" : "Shripati Bhat"  },  "image" : "https://global-uploads.webflow.com/5ef788f07804fb7d78a4127a/6051f4ce02749f74c95fa40c_YsIrX8E4Tkhxn08b0k4bB4Vo9jpy18OSaYTtWk_MqirunusVCzTajh4IRhkqKipxA0IF9_FWMXS1uLFfSyOtG22TF-tr-Qc8lrMFxOl8mMxiuV0zu5U02cHz1swze2ftviP_SoBZ.png",  "articleSection" : "So a logical diagram would look like this:",  "articleBody" : "Similar to how you use a language dictionary to understand the words of the language, we need to look at the documentation of a system to understand the request and the response formats. What details will be sent and what will be received are more specific to each system that we talk to.</P><P>The next time you are looking for an integration between two systems, remember that APIs are just two people (systems) talking to each other under all the technical layers",  "publisher" : {    "@type" : "Organization",    "name" : "Engati"  }} ]</script>

Tech Corner

How technical are APIs?

Shripati Bhat
.
Mar 17
.
2-3 mins

Table of contents

Key takeawaysCollaboration platforms are essential to the new way of workingEmployees prefer engati over emailEmployees play a growing part in software purchasing decisionsThe future of work is collaborativeMethodology

The driver for this article is not to start a debate on what things need technological prowess to understand versus the logical components of a highly scalable SaaS-based platform. We intend to help you fit a complex system into a logical block in a way that a layperson can understand.

API means Talking 

Let's take an example where you are talking to your friend. If the two of you speak in the same language, it’s convenient for one person to understand what the other is saying.

But imagine having the same discussion with a person who doesn’t speak the language. It seems tricky, right? 

Replace the people in these pictures with systems. APIs can be thought of as the communication medium across the system. Let’s take an example. You have two systems; System A is Engati, and System B is a ticketing system. Say you’d like to create a ticket using System B through Engati. To achieve this, both systems need to communicate in one language; They need to follow one API standard.

Now you must be wondering if there are different languages to communicate between these systems. Of course, there are. Similar to how languages like English, French, Italian, and Hindi exist, there are multiple ways to communicate, like HTTP REST, SOAP, GraphQL, Sockets, etc. And just like English is a language that most people try to talk to communicate globally, systems often tend to support REST API-based communication (then again, there is always a group of people who don't like to speak English)!

What is a REST API?

Just like how every language has grammar, syntaxes, and dos and don'ts, communication between systems has its own set of rules. Let's look at the details of the parts of speech/grammar equivalence for a REST API.

 

Header URL : https://ticket-system.com/create Request Type: POST Body "firstName" : "John", "lastName" : "Denver", "phone" : "555-123-6789", "email" : "jdenver@myorg.com", "reason" : "Pricing" Request Types: GET — used to fetch data from target system POST — used to create data in target system PUT — used to update data in target system Metadata of the Request Entire Data of the Request DELETE — used to delete data from target system

Going back to our example of Engati attempting to create a ticket in the ticketing system, that is a create operation. Hence Engati will have to invoke a REST API in the ticketing system. To invoke the API, you would need to know the parts of speech/grammar equivalence, i.e., the URL, Parameters, Request Type (which ideally should be POST), Request Body.

So a logical diagram would look like this: 

I want to create a ticket..! Here are my details Engati Platform Response Request Ticketing System Sure..!! Here you go with the ticket.

Similar to how you use a language dictionary to understand the words of the language, we need to look at the documentation of a system to understand the request and the response formats. What details will be sent and what will be received are more specific to each system that we talk to.

The next time you are looking for an integration between two systems, remember that APIs are just two people (systems) talking to each other under all the technical layers.

Engati's extensive documentation page can help you navigate through APIs to create extensive functionality around the platform. 

Share
Share

Shripati Bhat

Shripati is a Senior Technical Manager at Engati. He's a technical enthusiast, passionate about designing and building scalable software.

Shripati has a deeply ingrained customer-first ideology and is skilled in designing and developing Java/J2EE applications and BigData applications.

Andy is the Co-Founder and CIO of SwissCognitive - The Global AI Hub. He’s also the President of the Swiss IT Leadership Forum.

Andy is a digital enterprise leader and is transforming business strategies keeping the best interests of shareholders, customers, and employees in mind.

Follow him for your daily dose of AI news and thoughts on using AI to improve your business.

Catch our interview with Andy on AI in daily life

Continue Reading