Skip to main content

Rest Sender Connector

REST Sender connector allows opening a REST service on MIP via an entered URI address, sending requests to this address and thus triggering integrations.

Required Connector Properties​

  • Address: The area where the address of the REST service to be opened via MIP is defined. It specifies the endpoint or resource location within the RESTful API. For instance, it might be represented as “/mip/api/getFile”.

  • Method: In REST services, "method" is also referred to as HTTP method or HTTP verb. The HTTP method specifies the purpose of a request and defines the operation to be performed on a specific resource. RESTful services perform various operations on resources using HTTP methods:

    • GET: Used for reading a resource. It is used to retrieve data from the server without modifying resources.
    • POST: Used to create a new resource. Typically used for resource creation.
    • PUT: Used to update a resource. Often used to update the entire resource.
    • PATCH: Used to update specific fields of a resource. It updates only specific fields, not the entire resource.
    • DELETE: Used to delete a resource.

  • Keep Headers: The "Keep Headers" option specifies whether headers received in the response of an HTTP request will be retained. This option is often used to preserve or discard header information between the HTTP request and response.

  • Synchronous Endpoint: Synchronous Endpoint is typically preferred for situations that require a quick response. When this option is used, a request sent by a client is processed immediately, and a response is expected to be received. This implies that operations are carried out instantly. Contrarily, if this feature is not selected, this Endpoint is named Asynchronous Endpoint, and in its usage, the client sends a request, but the response is not received immediately. The request is processed in the background by the server, and after some time, a response is communicated to the client. In this case, the client does not have to wait for the process and can proceed with other tasks.