README

API包为Contao 4添加了Leading Systems API功能。

此扩展旨在协助其他Leading Systems扩展，如电子商务扩展Merconis。技术上，可以独立使用，但我们不会为此扩展提供支持，除非它与Merconis结合使用。

有关更多信息，请访问Merconis网站

LS API是什么？它有什么好处？

LS API为Contao添加了类似REST的API功能，允许您编写自己的API资源。

LS API可用于Contao的前端和后端，并附带基本的身份验证和授权系统。

安装此Contao扩展后，Contao后端导航将出现一个新的导航组“LS API”。其中一项导航项标记为“API接收器”。点击它将在浏览器窗口中打开后端API端点。由于未指定API资源，API将向您提供一个包含所有可用资源信息的JSON响应。

后端API端点的URL看起来像这样

http://mydomain.com/contao?do=be_mod_ls_apiReceiver

要调用特定的API资源，需要在URL中添加“resource”参数

http://mydomain.com/contao?do=be_mod_ls_apiReceiver&resource=getCurrentBackendUserName

直接调用此URL会导致“拒绝访问”响应，因为我们没有指定API密钥。

{
"status": "error",   
"data": null,
"message": "Access denied",  
"code": 0  
}

为了在访问资源时使用我们的API凭据，我们需要向API URL发送以下POST参数的POST请求

ls_api_key:       SOME-KEY-SPECIFIED-IN-THE-CONTAO-BACKEND
ls_api_username:  username-of-an-api-user
ls_api_password:  password-of-an-api-user

API可以接受API用户、前端用户或后端用户，具体取决于请求的资源。如果资源仅接受API用户（在后台明确定义为API用户的用户），则参数ls_api_username和ls_api_password是必需的。

如果资源接受前端或后端用户，则参数ls_api_key仍需要提供，但如果已登录前端或后端用户，则可以省略API用户的用户凭据。

要创建前端API端点，您必须创建一个类型为LS API RECEIVER的前端模块，并将该前端模块放置在前端页面上（例如，使用内容元素或将其放置在布局中）。

然后您可以通过调用此页面来调用API

http://mydomain.com/api.html

要调用特定的API资源，需要在URL中添加“resource”参数

http://mydomain.com/api/resource/getCurrentFrontendUserName.html

直接调用此URL会导致“拒绝访问”响应，因为我们没有指定API密钥。前端API端点的行为与之前提到的后端API端点完全相同。