接口坞
    接口坞
    • 概述
    • 身份认证
    • 枚举接口
      GET
    • 节假日接口
      GET
    • 节假日获取工作日下一天接口
      GET
    • 行政区划接口
      GET
    • 汉字转拼音接口
      GET
    • IPv4归属地-城市级
      GET

      枚举接口

      GET
      /enum/get

      接口说明:#

      在接口对接的过程中,您可能会遇到大量的枚举类型。通过此枚举接口,您可以轻松地获取每个枚举类型的所有枚举值,从而使整个对接过程更加清晰和易于理解。

      频次限制#

      匿名用户:5次/天
      普通用户:60次/分钟
      注:
      匿名用户主要为请求中未携带任何身份标识的用户,主要以IP作为频次限制条件。
      普通用户为通过API KEY或签名认证或登录TOKEN等所有有效身份标识的用户,以用户作为频次限制条件。

      收费说明#

      匿名用户访问方式免费,后面有可能关闭,不推荐使用。
      普通用户会在资源包中扣除用量,余量不足时暂停访问。 购买资源包

      枚举类型:#

      ErrorCode 错误码枚举
      Gender 性别枚举
      Sort 排序枚举
      Week 周枚举
      Weekend 是否为周末枚举
      Workday 是否为工作日枚举
      Holiday 节假日枚举
      HolidayField 节假日字段枚举
      HolidayLegal 是否为法定节假日枚举
      HolidayRecess 是否为假期节假日枚举
      HolidayToday 是否为节日当天枚举
      AdministrativeDivisionField 行政区划字段枚举
      AdministrativeDivisionLevel 行政区划层级枚举
      AdministrativeDivisionType 行政区划类型枚举

      请求参数

      Authorization
      在 query 添加参数
      api_key
      示例:
      api_key: ********************
      Query 参数
      enum
      string 
      必需
      枚举类型,详见上面说明中的枚举类型列表
      示例值:
      ErrorCode

      示例代码

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://api.apihubs.cn/enum/get?enum=ErrorCode&api_key'

      返回响应

      🟢200成功
      application/json
      Body
      code
      integer 
      错误码
      必需
      0为成功,可以作为判断成功的依据,其他错误码可通过枚举接口获取
      示例值:
      0
      msg
      string 
      错误信息
      必需
      ok为成功,不能作为判断成功的依据,其他错误码可通过枚举接口获取
      示例值:
      ok
      data
      array[object (枚举信息) {5}] 
      响应数据
      必需
      enumName
      string 
      枚举名称
      必需
      枚举名称
      示例值:
      OK
      code
      integer 
      枚举代码
      可选
      在不同枚举类型中可能为空
      示例值:
      0
      name
      string 
      枚举名称
      可选
      在不同枚举类型中可能为空
      示例值:
      ok
      msg
      string 
      错误信息
      可选
      在不同枚举类型中可能为空
      示例值:
      ok
      field
      string 
      字段
      可选
      在不同枚举类型中可能为空
      示例值:
      year
      示例
      {
          "code": 0,
          "msg": "ok",
          "data": [
              {
                  "code": 0,
                  "msg": "ok",
                  "enumName": "OK"
              },
              {
                  "code": 99999,
                  "msg": "服务器繁忙,请稍后再试",
                  "enumName": "UNKNOWN_ERROR"
              },
              {
                  "code": 80001,
                  "msg": "您请求的接口地址不存在",
                  "enumName": "EXCEPTION_HTTP_NOT_FOUND"
              },
              {
                  "code": 80002,
                  "msg": "您请求接口使用的方法(Method)不正确",
                  "enumName": "EXCEPTION_HTTP_METHOD_NOT_ALLOWED"
              },
              {
                  "code": 80003,
                  "msg": "身份认证失败,请重新登录后再试",
                  "enumName": "EXCEPTION_AUTHENTICATION"
              },
              {
                  "code": 80004,
                  "msg": "您没有权限访问",
                  "enumName": "EXCEPTION_AUTHORIZATION"
              },
              {
                  "code": 80005,
                  "msg": "参数验证失败",
                  "enumName": "EXCEPTION_VALIDATION"
              },
              {
                  "code": 80006,
                  "msg": "请求过于频繁",
                  "enumName": "EXCEPTION_THROTTLE_REQUESTS"
              },
              {
                  "code": 10001,
                  "msg": "登录失败",
                  "enumName": "ERROR_LOGIN_FAIL"
              },
              {
                  "code": 10010,
                  "msg": "参数为空",
                  "enumName": "ERROR_EMPTY_PARAMS"
              },
              {
                  "code": 12000,
                  "msg": "签名错误",
                  "enumName": "ERROR_SIGN"
              }
          ]
      }
      修改于 2023-11-03 16:54:44
      上一页
      身份认证
      下一页
      节假日接口
      Built with