All Collections
API Builder/Gateway
1. API Builder Tutorial - Introduction
1. API Builder Tutorial - Introduction

Design and create an API directly in Synatic using the API Builder

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Let's first define an API and its uses

The term API is an acronym, and it stands for Application Programming Interface.

In simple terms, an API is a software information gateway that allows the back ends of software and services to talk to each other. In other words, an API is a messenger that delivers your request to the provider that you're requesting information from, and then it delivers the response back to you.

In Synatic, you can use the API Builder to design and create your own API to build a set of dedicated URLs and routes to integrate with other applications. You would use the API to extract and copy information from one application and transfer it to another without knowing any programming or about how they are implemented.

Synatic - API Basics

A typical real-life example could be to create a single customer view by extracting and aggregating a diverse set of data held by an organization about its customers, which can be viewed in one place, such as a single page.

About this Tutorial

In this tutorial, you will learn how to create a Book Store API and the associated process logic, which you can expose as routes in Synatic's API Builder. This allows you to easily build the back-end for an App, a Website, or other third-party system integration.

You'll find that Synatic is a handy tool to create data flows and build these integrations.

  • This tutorial demonstrates how to create a basic RESTful API for a BookStore using Create, Read, Update and Delete operations, often referred to by the acronym CRUD.

  • SQL Server is used as the database, and Synatic creates the rest of the API functionality.

  • The following API routes will be created in five parts:
    GET /Books - Read all book entries in the catalog.
    GET /Books/{id} - Read a particular book entry by a unique 'id'.
    POST /Books - Create a new book entry in the catalog.
    PUT /Books/{id} - Update a book entry for a unique 'id'.
    DELETE /Books/{id} - Delete a book entry for a unique 'id'.

  • The Postman platform is used to test the APIs you build.

The API you will create should look and operate something like this workflow map.

Synatic - API Tutorial Workflow Map

Did this answer your question?