Web API

Web API is an interface that facilitates communication between software applications. It allows you to develop and integrate your domain into proprietary applications or third party systems. RESTful API invocations consist of a request sent by the client and a response returned by the server.
A RESTful API includes three main components:
  1. HTTP action
    : It defines the action to be performed on the URL endpoint resource.
    HTTP action
    GET
    Read
    POST
    Create
    PUT
    Update/Replace
    PATCH
    Partial update/Modify
    DELETE
    Delete
  2. URL endpoint
    : It consists of an URL link representing the resources that you want to acces, such us text, image, documents or data.
  3. Body message
    : It includes properties and values to create or update a given resource. A body message might include
    headers
    . Headers are property-value pairs that are separated by a colon and used for entering information about the body content.

Server response

Once the server has received the request from a client, it sends a response that consists of two parts:
  1. HTTP status code
    :
    • 200
      : The request has succeeded.
    • 300
      : The request is redirected to another URL.
    • 400
      : An error that originates from the client has occurred.
    • 500
      : An error originating from the server has occurred.
  2. Body
    : The response body is optionally provided and its message may vary depending on the server response.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal