Endpoint (POST)

The Endpoint API allows users to create endpoint configurations for supported interface protocols.

URL

POST /wms/lgfapi/v10/entity/endpoint

Highlights / Behavior

• Supports configuration of endpoint details such as protocol, authentication type, and connection properties.
• Enables flexible setup for multiple interface protocols.
• Authentication details (username, password) are optional depending on the selected authentication type.
• Ports and directories are configurable based on the endpoint type.

Request Parameters

Category	Name	Required	Type	Description
Options	company_id	Yes	Integer	Company identifier in WMS.
Options	endpoint_name	Yes	String	Unique name for the endpoint configuration.
Options	endpoint_interface_protocol	Yes	String	Protocol used for the endpoint (e.g., FTP, SFTP, HTTPS).
Options	endpoint_authentication_type	No	String	Authentication type (e.g., Basic, OAuth).
Options	username	No	String	Username for endpoint authentication (if required).
Options	password	No	String	Password for endpoint authentication (if required).
Options	port	No	Integer	Communication port for the endpoint.
Options	target_directory	No	String	Target directory path for endpoint integration.

Sample Request Body

{
  "fields": {
    "company_id": "1081",
    "endpoint_name": "SPENDPOINT01",
    "endpoint_interface_protocol_id": "3",
    "endpoint_auth_type_id": "1",
    "username": "XYZ",
    "password": "xyz123*",
    "host": "ht",
    "port": "8080",
    "target_dir": "target_directory"
  }
}

Sample Response

{
  "success": true,
  "response": {
    "message": "Endpoint successfully configured",
    "endpoint_id": "EP_1001"
  }
}