API接口文档

欢迎使用IUCA接口服务。本页面提供了可用API接口的详细说明,包括接口地址、请求方法、参数说明及返回值格式。

注意:使用API接口前,请确保您已获得有效的API密钥。

重要提示:因合规性问题,违规用户API已被无限期禁用。

API认证

所有API请求都需要通过API密钥进行认证。您可以通过以下两种方式提供API密钥:

通过URL参数认证

GET /api/endpoint.php?apikey=您的API密钥

通过请求头认证

GET /api/endpoint.php
API_KEY: 您的API密钥

接口说明

以下是当前系统提供的API接口列表:

GET IDC查询接口 查看详情
GET /api/query_idc_api.php?apikey=您的API密钥&idc=IDC标识

根据IDC标识查询IDC信息。

GET IDC搜索接口 查看详情
GET /api/search_idc.php?apikey=您的API密钥&keyword=关键词

根据关键词搜索IDC信息。

GET 获取首页消息 查看详情
GET /api/get_homepage_message.php?apikey=您的API密钥

获取系统首页显示的消息。

GET 违规用户列表(已禁用)
GET /api/violation_users_api.php

此接口已被禁用,调用将返回403状态码及禁用提示。

GET 单个违规用户详情(已禁用)
GET /api/violation_users_api.php/{id}

此接口已被禁用,调用将返回403状态码及禁用提示。

POST 添加新违规用户(已禁用)
POST /api/violation_users_api.php

此接口已被禁用,调用将返回403状态码及禁用提示。

PUT 更新违规用户(已禁用)
PUT /api/violation_users_api.php/{id}

此接口已被禁用,调用将返回403状态码及禁用提示。

错误码说明

状态码 错误信息 说明
401 无效的API密钥 提供的API密钥无效或已过期
403 API已被禁用 请求的API接口已被禁用
404 未找到请求的资源 请求的资源不存在
405 不支持的请求方法 使用了不支持的HTTP方法
500 服务器内部错误 服务器处理请求时发生错误

API密钥申请

要使用我们的API接口,您需要先申请API密钥。每个用户只能申请一个API密钥,验证邮箱后即可立即获得。

申请流程

  1. 点击这里进入API密钥申请页面
  2. 填写您的相关信息,包括应用名称、用途说明等
  3. 完成邮箱验证
  4. 验证通过后,系统将自动为您生成API密钥,可立即用于调用我们的API接口

注意:每个用户只能拥有一个活跃的API密钥。请妥善保管您的API密钥,避免泄露给未授权的第三方。