Zoho crm Logo

特性API

功能 API 允许您获取有关组织中的功能及其限制的信息。这些限制可能会根据您的组织版本的不同而有所不同。

目的

获取您当前组织的功能及其限制的详细信息。

端点

  • GET /__features
  • GET /__features?module={module_api_name}
  • GET /__features?api_names={feature_api_name_1},{feature_api_name_2}
  • GET /__features/{feature_api_name}

请求详情

Request URLs

  • 获取所有可用的功能及其对应的限制:

    {api-domain}/crm/{version}/__features

  • 检索特定功能:

    {api-domain}/crm/{version}/__features?api_names={feature_api_name_1},{feature_api_name_2}

  • 检索与模块特定的所有特性:

    {api-domain}/crm/{version}/__features?module={module_api_name}

  • 获取特定功能及其子功能的详细信息:

    {api-domain}/crm/{version}/__features/{feature_api_name}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.features.READ

参数

  • 模块字符串,可选

    要检索特定模块的所有可用功能及其限制,请指定该模块的模块API名称。

  • api_names字符串,可选

    指定功能api名称以检索特定于该功能的详细信息和限制。要检索多个功能的详细信息,请以逗号分隔的格式给出功能api名称。

  • 页面整数,可选

    获取相应页面的功能列表。页面的默认值为1。
    可能的值:仅正整数。

  • per_pageinteger, optional

    获取每页可用的功能列表。默认值和可能的最大值是200。
    可能的值:仅正整数。

  • page_token字符串,如果要获取超过2000个服务,必须通过分页

    您可以使用page参数获取最多2000个特性,而无需page_token。要获取超过2000个特性,您必须在请求中包含page_token参数。此参数取自第一次GET特性调用的响应中的next_page_token键的值。此令牌值是用户特定的,如果您使用其他用户的令牌,系统将抛出错误。
    页面令牌与参数绑定,并在24小时后过期。此外,您不能将此参数与page参数一起使用。

样本请求

Response JSON 键

  • 组件JSON 数组

    代表功能组件的详细信息。

    • api_namestring

      代表功能的api名称。

    • module_supportedboolean

      它表示该功能是否特定于一个模块。

    • detailsJSON object

      包含有关功能限制的详细信息。

      • limitsJSON object

        它代表与功能相关的限制。

        • edition_limitsinteger

          它代表当前版本分配的功能的最大计数。

        • totalinteger

          它代表分配给当前组织的功能的实际计数。

  • feature_labelstring

    它代表了用户界面中的功能名称。这将被翻译成用户的语言。

  • parent_featurestring

    如果适用,它代表相应特性的父特性。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方案:您指定了无效的HTTP方法来访问API URL。
    指定一个有效的请求方法。请参考上面的端点部分。

  • INVALID_MODULEHTTP 400

    给出的模块名称似乎无效
    解决方案:您指定的模块名称无效。
    请指定一个有效的模块名称。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有ZohoCRM.features.READ 范围。
    生成具有有效范围的新令牌。有关更多详细信息,请参阅上面的范围部分。

  • AUTHENTICATION_FAILUREHTTP 401

    身份验证失败
    解决方案:在API调用的请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

    请检查试图访问的URL是否正确
    解决方案:指定的请求URL不正确。指定一个有效的请求URL。 Refer to the request URL section above.

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中出现意外且未处理的异常。联系支持团队。

样本回应