Showing posts with label Web API. Show all posts
Showing posts with label Web API. Show all posts

Understanding HTTP, Web APIs, and API Endpoints

 

Understanding HTTP, Web APIs, and API Endpoints

In the digital age, the seamless interaction between different software applications is paramount. This is where the concepts of HTTP, Web APIs, and API endpoints come into play, serving as the backbone of communication in the vast landscape of the internet and software applications. Let's delve into these concepts to understand their roles and how they work together to facilitate this communication.

How Service Protection API Limits are enforced

How Service Protection API Limits are enforced

 Reference

Service protection API limits are enforced based on three facets:

  • The number of requests sent by a user.
  • The combined execution time required to process requests sent by a user.
  • The number of concurrent requests sent by a user.

If the only limit was on the number of requests sent by a user, it would be possible to bypass it. The other facets were added to counter these attempts. For example:

  • You could send fewer requests by bundling them in batch operations.
    • The combined execution time limit will counter this.
  • Rather than sending requests individually in succession, you could send a large number of concurrent requests before service protection API limits are enforced.
    • The concurrent request limit will counter this.

Each web server available to your environment will enforce these limits independently. Most environments will have more than one web server. Trial environments are allocated only a single web server. The actual number of web servers that are available to your environment depends on multiple factors that are part of the managed service we provide. One of the factors is how many user licenses you have purchased.

The following table describes the default service protection API limits enforced per web server:




[Demo] Control your TESLA through Siri and Power Automate

[Demo] Control your TESLA through Siri and Power Automate

Imagine a scenario: in a freezing cold winter, you are heading to the parking lot for your Tesla car. You are holding a big box and have no hand to take out the phone then choose the commands from the menus to turn on the AC remotely, or open the rear trunk. So you just talk to your Apple watch and tell Siri to command the car easily and promptly. Is it an interesting experience you wanna try? If so, you may follow the below steps to finish your personal control application.

REST vs OData

REST vs OData

Understanding the Concept of REST APIs

Image Source: Astera Software

REST (REpresentational State Transfer) refers to a Software Architectural Style that defines the standards for exchanging information between two different systems via the HTTP Protocol. It is the most popular architecture for exchanging data on the World Wide Web.

REST defines 6 different principles for Web Services:

  • Uniform Interface: All components in a REST system must adhere to the same interface and rules so as to communicate with each other. 
  • Client-Server: REST separates Servers from Clients. The Servers store information, while the Clients retrieve information from the Servers. 
  • Stateless: All requests made via REST are stateless. They have all the necessary information needed by the Server to execute the request. 
  • Cacheable: In REST, both Clients and Servers can cache resources, which is good for reducing traffic and improving performance. 
  • Layered System: REST supports a Layered System Architecture. The Client may communicate with one Server, while the other Servers perform tasks such as Data Storage and Authentication. 
  • Code on Demand: REST requisitions may return executable code or logic when necessary (optional). 

Any API (Application Programming Interface) that follows the above principles is referred to as a REST API. In most cases, REST APIs use XML or JSON, but the REST Architecture doesn’t require anything specific as far as this is concerned. REST does not require any particular format, but it accepts any format that can be used in Content Negotiation

Understanding the Concept of OData

OData (Open Data Protocol) is a set of best practices for developing and using RESTful APIs. It helps you to focus on your Business Logic while creating RESTful APIs without the need to worry about various ways to define request and response Headers, HTTP Methods, Status Codes, Media Types, URL Conventions, Payload Formats, and more. 

Image Source: Progress Software

OData carries the following specifications:

  1. It must follow REST principles unless there is a clear reason why it should not.
  2. The OData services MUST have support for Atom encoding.
  3. OData services SHOULD have support for JSON encoding. 

REST is the most essential component technology of OData. OData 3.0 standards require OData users to follow REST principles. OData rests on HTML technology, which resolves the problem of being REST-based in a way. It supports two Protocols for Data Transfer, the XML-based Atom format and JSON. 

OData also has guidance for performing actions like defining reusable procedures, tracking changes, and sending many REST requests.  

It provides two models for Data Management which include:

  1. Entity Data Model (EDM): This is an abstract Data Model that OData users MUST use to describe the exposed data. 
  2. Service Model: It is made up of Static Resources and a set of Dynamic Resources. The work of the Static Resources is to provide a way of asking the Service about its Data Model, while the Dynamic Resources provide methods to manage the Data Model.

In the next section, we will be discussing OData vs REST APIs to know how the two compare in different core areas. 

OData vs REST APIs: What’s the Difference?

Let’s now discuss how OData and REST APIs compare to each other:

OData vs REST APIs: Function

REST Function

REST is an architecture that defines how to send messages between a Client and a Server via HTTP. It is a model that states that you can use HTTP and its verbs to perform CRUD Operations (Create, Read, Update, Delete) on the resources exposed by your Services. Thus, REST is more concerned about the architecture. 

OData Function

OData is a standard from Microsoft that relies on the REST Architecture to send specific types of messages over HTTP. It defines metadata in CSDL (Common Schema Definition Language) format to describe the Entity types supported by your Service and their Properties, Data types, and more. Thus, OData is more concerned about the content.

OData vs REST APIs: Principles

REST Principles

REST defines 6 principles, as has been listed above, to ensure the creation of efficient Web Services and REST APIs must follow these principles. These principles ensure the success of REST Projects. 

OData Principles

OData is built on top of the REST Framework, thus, it depends on REST principles. Note that even though OData recommends its users to follow REST principles every time, the requirement can be relaxed in the case of a good reason. A very basic, Compliant Service should be easy to build, with additional work necessary only to support additional capabilities. 

OData vs REST APIs: Best Use Case

REST API Best Use Case

REST is used when there is a need to interact with a Data Source, for example, to retrieve data for all Products. It is easier and faster to parse data using REST APIs. It uses URI to expose the Business Logic. 

The following operations are available on HTTP:

Image Source: Medium

OData Best Use Case

OData is best used to expose Services and APIs to Systems and Applications. It has facilities for extension to achieve the custom needs of the REST APIs. 

OData vs REST APIs: Data Transfer Format

REST Data Transfer Format

Data transfer format is an important factor to consider when comparing OData vs REST. REST supports the transfer of data in any format. Although most REST APIs use XML and JSON formats, REST is not specific in regard to this. 

OData Data Transfer Format

OData specifies that the data should be transferred in either JSON, XML, or Atom format. 

Those were the major differences between OData vs REST.  

Conclusion

This blog discussed fine differences across OData vs REST APIs. We also discussed concepts behind OData and REST APIs, their specifications and principles. 

For Businesses, extracting complex data from a diverse set of Data Sources such as REST APIs can be a challenging task. This is where Hevo saves the day by providing an efficient, reliable and fast ETL Service.

[DEMO] Synchronize Data from Business Central to Dynamics CE (Dataverse) through OData (Web API)

 Synchronize Data from Business Central to Dynamics CE (Dataverse) through OData (Web API)

Business Central Web Services: Page vs Codeunit vs Query Differences

 

Business Central Web Services

Business Central supports three types of web services: API, SOAP, and OData.

Creating HTML Web Resource To Show Image Attached In Notes Using Web API

 https://www.c-sharpcorner.com/article/creating-html-web-resource-to-show-image-attached-in-notes-using-web-api/