OhMyGPT公开API文档
  1. OAuth开放API
OhMyGPT公开API文档
  • 本站介绍
  • 更新日志
  • 新版网站介绍
  • 自助开票系统使用文档
  • Telegram Bot使用文档
  • 自建Cloudflare Worker反代教程
  • Files文件存储服务 开放API
    • 文件存储服务
    • 文件上传
      POST
    • 文件信息更新
      POST
    • 删除文件
      POST
    • 用户查询 (分页)
      POST
    • 文件下载接口(Public公开文件下载)
      GET
    • 文件下载接口(Private私有文件下载)
      GET
  • OAuth开放API
    • 开放OAuth API介绍
    • 用户授权页
      GET
    • Code展示页
      GET
    • 申请access_token
      POST
    • 读取用户基本信息
      POST
    • 读取用户余额信息
      POST
    • 收取用户费用
      POST
    • 为用户创建一个Stripe Checkout充值订单
      POST
    • 为用户创建一个Stripe Invoice充值订单
      POST
    • 调用其它开放API
      POST
    • 通过OAuth Token读取用户管理Token
      POST
    • 通过OAuth Token更新用户管理Token
      POST
  • Midjourney、SD图像生成 API
    • Midjourney开放API接口
      • Midjourney服务说明文档
      • Midjourney 文生图 任务创建
      • Midjourney 执行动作 任务创建
      • Midjourney Blend 混合图生图 任务创建
      • Midjourney Describe prompt提取 任务创建
      • Midjourney 查询指定任务ID 的执行状态
      • Midjourney 分页批量查询任务
      • 从对象存储获取Midjourney生成的图片
      • 通过WSRV反代Discord图片
      • 通过WSRV反代并压缩Discord图片
      • 从对象存储+WSRV获取Midjourney生成的图片
      • 从对象存储+WSRV获取Midjourney生成的图片(压缩)
    • 其它图像生成API
      • ND图像生成 API
    • Flux图像生成
      • Flux Schnell 图像生成
      • Flux Dev 图像生成
      • Flux Pro 图像生成
      • Flux Pro 1.1 图像生成
      • Flux 1.1 Pro Ultura 图像生成
  • 管理API列表
    • 创建新的API Key
    • 修改API Key信息
    • 查询用户所有的API Key
    • 删除指定API Key
    • 查询用户会员到期日期接口
    • 用户余额查询接口
    • 查询当前模型倍率接口
  • Claude
    • Anthropic 原生 Messages API
    • Anthropic 原生 Completions 企业商用 API
    • Anthropic 原生 Messages Token Count API
  • OpenAI
    • 关于OpenAI兼容API接口说明
    • 关于Azure OpenAI API接口服务说明
    • Audio
      • TTS文本转语音服务
    • Chat
      • Chat Completion
      • Completion (Legacy)
    • Images
      • 图像生成
      • Image Edit
    • Embeddings
      • Embeddings
    • Realtime 实时通话端点
    • Models
  • 其它开放API
    • 搜索API
      • Google Custom Search API
      • Google Search By Serper
    • Azure API
      • Azure 文本转语音
      • Azure 获取TTS 语音列表
  1. OAuth开放API

用户授权页

line1
line1
GET
https://next.ohmygpt.com/next/v1/oauth
按照参数规则配置好URL,并让用户在浏览器中打开此URL,从而要求用户授权您的应用,授权完成后将会获得Code并重定向到带参数的redirect_uri中
示例URL1:
https://next.aigptx.top/next/v1/oauth?response_type=code&client_id=6681463833ebdbb2566d1def&redirect_uri=https://next.aigptx.top/next/v1/oauth/succeed&scope=general_api_access&state=EXAMPLE_STATE
授权后将会重定向到:
https://next.aigptx.top/next/v1/oauth/succeed?code=gtsi4Ww0ADHKwqZi&state=EXAMPLE_STATE
效果图:
image.png
示例URL2:
https://next.aigptx.top/next/v1/oauth?response_type=code&client_id=6681463833ebdbb2566d1def&redirect_uri=https://wiki.getletbot.com/api/authorize&scope=general_api_access&state=EXAMPLE_STATE
授权后,将会跳转到:
https://wiki.getletbot.com/api/authorize?code=rA6HSC0xLXbV1lJj&state=EXAMPLE_STATE
作为开发者,您可以选择一下任意一种方式进行下一步流程:
1.
实现此GET接口,拿到code等参数以进一步完成OAuth授权流程
2.
让用户重定向到网站的 /next/v1/oauth/succeed 中,此页面可展示Code,并提示用户在您的应用中输入此Code
image.png
注:为照顾部分地区的用户,此处URL前缀也可以替换为:
https://next.aigptx.top/next/v1/oauth
关于redirect_template参数:
可自定义一个模板,从而实现更大自由度的跳转URL参数实现:
例如:
?code={code}&state={state}&tgid=114514
转换为base64为:P2NvZGU9e2NvZGV9JnN0YXRlPXtzdGF0ZX0mdGdpZD0xMTQ1MTQ=
授权成功后则会自动替换{code}和{state}为对应的参数,然后直接在前面拼接上redirect_uri执行跳转
附:base64转换小工具: https://it-tools.dogenet.win/base64-string-converter

请求参数

Query 参数
response_type
string 
必需
OAuth 授权类型 目前仅支持code
示例值:
code
client_id
string 
必需
OAuth App Client ID
示例值:
6681463833ebdbb2566d1def
redirect_uri
string 
必需
OAuth App 授权完成后的跳转URL,其域名需要和设置的一致,URL路径不需要一致
示例值:
https://wiki.getletbot.com/api/authorize
scope
string 
必需
OAuth App 请求的权限 需要和您的应用完全一致
示例值:
general_api_access
state
string 
可选
可选的OAuth回显参数,会在授权完成后原样回传,方便标记此授权码来自哪个用户
示例值:
EXAMPLE_STATE
redirect_template
string 
可选
自定义跳转参数模板(base64),如果您希望能自定义跳转参数,那么您可以添加此参数
示例值:
P2NvZGU9e2NvZGV9JnN0YXRlPXtzdGF0ZX0mdGdpZD0xMTQ1MTQ=

示例代码

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://next.ohmygpt.com/next/v1/oauth?response_type=code&client_id=6681463833ebdbb2566d1def&redirect_uri=https://wiki.getletbot.com/api/authorize&scope=general_api_access&state=EXAMPLE_STATE&redirect_template=P2NvZGU9e2NvZGV9JnN0YXRlPXtzdGF0ZX0mdGdpZD0xMTQ1MTQ='

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
修改于 2024-09-07 08:18:14
上一页
开放OAuth API介绍
下一页
Code展示页
Built with