Using the REST API reference (2024)

FAQs

What is REST API reference? ›

Representational State Transfer (REST) APIs are service endpoints that support sets of HTTP operations (methods), which provide create, retrieve, update, or delete access to the service's resources.

API docs, or API description documents, are the collection of references, tutorials, and examples that help developers use your API. Your API's documentation is the primary resource for explaining what is possible with your API and how to get started.

REST APIs communicate through HTTP requests to perform standard database functions like creating, reading, updating and deleting records (also known as CRUD) within a resource. For example, a REST API would use a GET request to retrieve a record. A POST request creates a new record.

A RESTful web service request contains: An Endpoint URL. An application implementing a RESTful API will define one or more URL endpoints with a domain, port, path, and/or query string — for example, https://mydomain/user/123?format=json .

At minimum, an API reference should contain a guide called "Using the name-of-api", which will provide a basic guide to how to use the API. More complex APIs may require multiple usage guides to explain how to use different aspects of the API.

The reference data API offers central source for any kind Eurex reference data, machine- and human readable format. No more downloading, polling and parsing of multiple files. API is based on GraphQL and JSON standards, which gives you flexibility retrieving data you need, without overfetching.

Mikromol's reference standards for active pharmaceutical ingredients (APIs) are primary quantitative standards – most of them are accredited to ISO 17034 standards and designed to ensure the highest analytical accuracy and reliability.

REST APIs use HTTP/HTTPS, while Web APIs use protocols like SOAP and BEEP in addition to HTTP/HTTPS. Protocol choice can impact speed and security, so it's important to consider this when selecting an API.

Why do we use REST API? ›

Systems that implement REST APIs can scale efficiently because REST optimizes client-server interactions. Statelessness removes server load because the server does not have to retain past client request information. Well-managed caching partially or completely eliminates some client-server interactions.

Suppose someone searches for bus tickets on a travel website. The travel website sends an API call to the various bus companies' servers and receives back information about what rides are available and how much they cost. From the user's perspective, this process should be almost instantaneous.

REST API concepts

To get access to a resource, the client sends an HTTP request. In return, the server generates an HTTP response with encoded data on the resource. Both types of REST messages are self-descriptive, meaning they contain information on how to interpret and process them.

REST API methods and request structure

Any REST request includes four essential parts: an HTTP method, an endpoint, headers, and a body.

A REST API source allows you to index content from repositories exposing their data through a REST API. When creating your REST API source, you must provide a JSON configuration allowing Coveo to retrieve content items.

A RESTful API is an architectural style for an application programming interface that uses HTTP requests to access and use data. That data can be used to GET , PUT , POST and DELETE data types, which refers to reading, updating, creating and deleting operations related to resources.