如何在Suite CRM 8中创建自定义V8 API

经过数日研究，我整理出在Suite CRM 8中创建V8版本自定义API的完整步骤，分享给开发者社区：

1. 配置API路由 #

在public/legacy/custom/modules/[你的模块名]/Api/V8目录下创建routes.yaml（目录不存在则手动创建），添加自定义路由规则：

custom_[模块名]_api:
    path: '/api/v8/module/[你的模块名]/[自定义操作名]'
    methods: ['GET', 'POST'] # 根据需求设置请求方法
    defaults:
        _controller: 'SuiteCRM\Custom\Controller\[自定义控制器名]::[对应方法名]'

2. 编写自定义API控制器 #

在public/legacy/custom/src/Controller目录下创建控制器文件，比如Custom[模块名]ApiController.php，示例代码如下：

<?php

namespace SuiteCRM\Custom\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
use SuiteCRM\Module\Controller\BaseController;

class Custom[模块名]ApiController extends BaseController
{
    public function [自定义方法名](Request $request): Response
    {
        // 获取请求参数（GET取query，POST取request）
        $requestParams = $request->isMethod('POST') ? $request->request->all() : $request->query->all();
        
        // 编写自定义业务逻辑，例如调用SuiteCRM内部服务、操作数据等
        $responseData = [
            'status' => 'success',
            'message' => '自定义API执行成功',
            'received_params' => $requestParams
        ];
        
        // 返回JSON格式响应
        return $this->json($responseData);
    }
}

3. 设置API访问权限 #

在public/legacy/custom/modules/[你的模块名]/Api/V8目录下创建permissions.yaml，配置可访问该API的角色：

custom_[模块名]_api:
    roles:
        - admin # 允许管理员访问
        - sales_user # 可添加其他需要访问的角色

4. 验证API可用性 #

1. 清除SuiteCRM缓存，确保配置生效：

php bin/console cache:clear

2. 通过curl或API调试工具（如Postman）测试API，需携带有效的Bearer令牌：

curl -X GET "http://你的SuiteCRM域名/api/v8/module/[你的模块名]/[自定义操作名]?test_param=123" -H "Authorization: Bearer 你的访问令牌"

内容的提问来源于stack exchange，提问作者Sanjeev Mallik