🎉 开放平台文档站换新颜。 欢迎填问卷给我们建议，意见，反馈，夸夸 →
Skip to Content
如何使用开发指南快速上手

快速上手

欢迎使用同济大学开放平台，本文将阐述如何快速接入API接口。

准备工作

选择适合的调用方式（命令行或Postman工具，推荐使用Postman）

命令行

Windows系统

  1. 按下 Win + R 键
  2. 输入 cmd 后回车

Mac系统

  1. 点击屏幕右上角的「聚焦搜索」（或按 Command + 空格）
  2. 输入「终端」后回车

Postman

第一步：下载安装 访问 Postman官网 ，官网会自动检测你的操作系统，并给出相应的下载按钮，下载完成后解压安装

安装后打开（首次使用需要注册账号），启动完毕后去用邮箱注册一个账号并登录进去，就可以开始使用它来测试 API

如何获取token

access_token是调用API接口的凭证，每个用户都需要获取自己的access_token。获取方式如下：

使用cURL

  • 如果提示curl不是命令，需要先安装：
    • Windows 10+：已自带无需安装
    • Mac：已自带无需安装
    • Linux：sudo apt install curl (Ubuntu)
curl --location --request POST 'https://api.tongji.edu.cn/v1/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=xxb-example-api' \
--data-urlencode 'client_secret=3fwowzYYEgcCci1p7UPUtqgg9xdiWejv' \
--data-urlencode 'grant_type=client_credentials'

使用Postman

一键导入

使用Postman导入一键导入接口，点击右上角「import」按钮，选择「Past Raw Text」，输入上面cURL内容

新建请求

点击左上角New，选择Request，输入请求名称，选择文件夹，点击保存

1. 选择请求方式

POST

2. 输入请求URL

https://api.tongji.edu.cn/v1/token 

3. 点击Headers

输入key为Content-Type，value为application/x-www-form-urlencoded

4. 点击Body

选择x-www-form-urlencoded,输入key为client_id，value为你自己的应用ID（xxb-example-api）；再添加一行，输入key为client_secret，value为你自己的应用密钥（3fwowzYYEgcCci1p7UPUtqgg9xdiWejv），grant_type为client_credentials

成功响应示例

{
  "access_token": "abc123def456...",
  "expires_in": 7200
}

💡 小提示：access_token有效期通常为2小时（7200秒），记得及时刷新哦~

调用API

使用上述账户获得的token仅用于访问测试专用的fake_api系列的接口

例如：获取fake_api用户信息

curl --location --request GET 'https://api.tongji.edu.cn/v1/fake_api/user' \
--header 'Authorization: Bearer 你的access_token'

Postman设置方法

  1. 复制上面的cURL内容
  2. 点击左上角「Import」按钮，选择「Past Raw Text」，粘贴上面cURL的内容
  3. 点击「Authorization」选项卡，选择Type为Bearer Token，在Token中输入你的access_token即可
  4. 点击Send发送请求查看结果

成功响应示例：

{
    "code": "A00000",
    "data": [
        {
            "deptCode": "000054",
            "deptName": "教育技术与计算中心",
            "name": "周杰伦",
            "pid": "10240000",
            "statusCode": "0",
            "statusName": "有效",
            "userId": "20666666",
            "userTypeCode": "1",
            "userTypeName": "教职工"
        }
    ],
    "msg": "成功"
}
架构说明