README

Concentrix代码挑战！

概述

Concentrix企业集团模块是为 Magento 2.4 设计的，用于通过REST API管理企业集团并将它们与客户关联。

安装

Composer（推荐）

在magento的根目录中执行以下命令

composer require concentrix/module-corporate-group

如果安装此包时遇到任何问题，请更新到最新版本的composer

composer self-update --2

Git

在仓库主页上，点击“代码”按钮，通过git克隆仓库，或者点击“下载Zip”下载模块并将其手动添加到magento的 app/code/Concentrix/CorporateGroup 目录

在两种情况下（composer或git），在magento的根目录中执行以下命令

bin/magento s:up

这应该足以使模块正确启动，尽管在少数情况下，还需要部署静态内容。这可以通过以下命令完成

bin/magento setup:static-content:deploy -f

如何使用API

由于这个Web API暴露给了匿名用户，因此无需令牌或任何类型的身份验证即可访问。

URL必须按照以下方式形成

http://<magento_url>/rest/all/{endpoint}

为了以可视方式定义此Web API的端点，您可以在Magento的Swagger UI中访问

http://<magento_url>/swagger/#/concentrixCorporateGroupCorporateGroupRepositoryV1

要使用API，您可以使用REST客户端（例如Postman或Insomnia）进行相应的请求，或者您可以直接执行curl命令。（您甚至可以直接从Swagger UI运行！）

Curl示例

curl -X 'POST' \
  'http://magento2.test/rest/all/V1/concentrix/corporate-groups' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "corporateGroup": {
    "internal_code": "string",
    "name": "string",
    "email": "string",
    "telephone": "string"
  }
}'

管理企业集团

有4个主要端点

1. 创建新的企业集团

V1/concentrix/corporate-groups POST

请求示例

{
  "corporateGroup": {
    "internal_code": "unique_code",
    "name": "Test Group Name or Label",
    "email": "test@concentrix.com",
    "telephone": "+525512345678"
  }
}

2. 获取企业集团

V1/concentrix/corporate-groups/{internalCode} GET

请求示例

此请求没有请求体，必须通过URL传递internal_code

3. 删除企业集团

V1/concentrix/corporate-groups PUT

对于此端点，我没有使用DELETE方法，因为我无法解决一个bug :( 对不起

请求示例

{
  "internalCode": "unique_code"
}

4. 搜索企业集团（s）

V1/concentrix/corporate-groups GET

此请求没有请求体，URL必须符合一对SearchCriteria参数（更多详细信息请参阅您的magento实例的Swagger UI）

V1/concentrix/corporate-groups?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D={field_name}&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D={value}

示例（按电话搜索）

V1/concentrix/corporate-groups?searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=telephone&searchCriteria%5BfilterGroups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=+525512345678

将客户组绑定到客户

还有另外两个端点用于将客户与商业集团关联

1. 通过客户ID将企业集团与客户关联

V1/concentrix/corporate-groups/link-customer-by-id POST

请求示例

{
  "internalCode": "unique_code",
  "customerId": 1
}

2. 通过客户电子邮件将企业集团与客户关联

V1/concentrix/corporate-groups/link-customer-by-email POST

请求示例

{
  "internalCode": "unique_code",
  "customerEmail": "example@concentrix.com"
}

您还可以通过magento管理员将客户与现有的企业集团关联，方法是转到 客户 > 所有客户，然后点击所选客户并转到 账户信息 选项卡

就这样！