Endpoints

You can integrate any external system with LDAS through the Endpoint.

Integration Mode refers to the method or protocol used to connect an external instrument or system to the LDAS for data exchange.

There are two Integration modes through which we can integrate namely,

Rest API - Through Rest API we can connect to external system by giving the API connection details.
Database Query - Through Database Query we can connect to external system by giving the query and details of the database.

The users can change the Endpoint status to Active or Inactive as per need. Endpoint management page can be accessed from the settings icon.

You can access endpoint page from dashboard by clicking the Settings and clicking the icon Endpoint.

Creation of Endpoint for External system push

Field Name	Description	Mandatory Fields
Name	Provide a name for the endpoint	Yes
Description	Provide a description for the endpoint	No
Use External System Push (Toggle)	If enabled, the created endpoint can be used for external system push	Yes
Request URL	Provide the URL of the external API to which you are either pushing results from LDAS or retrieving results to LDAS. Select the appropriate method, such as GET or POST	Yes

Field Name	Description	Mandatory Fields
Name	Provide a name for the endpoint	Yes
Description	Provide a description for the endpoint	No
Integration Mode	Select REST API from the integration mode dropdown. Once chosen, this option cannot be edited	Yes
Parameterized	Select Yes/No from parameterized. By default, it is set as No	Yes
Select Method	Select the appropriate method, such as GET or POST	Yes
Request URL	Provide the URL of the external API to which you are either ushing results from LDAS or retrieving results to LDAS.	Yes
Header	Provide the key and value to the endpoint’s header.
Key	Provide the name that identifies a piece of data	Yes
Value	Provide the information that the key is referring to	Yes
Add Row	If you want to add more key-value pairs, you can use the "Add Rows" option to create additional pairs.	No
Body	You can add the JSON body required for the API.
Authentication	Provide the appropriate authorization required for the API, such as Auth, Basic Auth, or OAuth.
Auth	You do not require any form of authentication for access.
Basic Auth	You need to provide the username and password.
OAuth	You need to provide the following: Grant type – Password credentials/Client credentials Access token URL Client ID Client secret Client Authentication – Send as Basic Auth Header/Send client credentials in header.

Field Name	Description	Mandatory Fields
Name	Provide a name for the endpoint	Yes
Description	Provide a description for the endpoint	No
Integration Mode	Select Database Query from the integration mode dropdown. Once chosen, this option you cannot be edited	Yes
Parameterized	Select Yes/No from parametrized. By default, it is set it as No	Yes
Database URL	Provide the URL of the database to which you can retrieving results to LDAS.	Yes