API 文档
使用我们的 RESTful API 轻松集成到您的应用程序中
认证
所有 API 请求需要在 URL 参数中携带 token 进行认证。
URL 参数
token=YOUR_API_TOKEN
您可以在个人中心获取您的 API Token。请妥善保管,不要泄露给他人。
基础信息
| Base URL | https://gapi.mailsapi.com |
| 返回格式 | JSON |
GET
/api/code/email获取验证码邮箱
获取一个用于接收验证码的邮箱地址,返回订单号和邮箱账号
请求参数
token * | string | API Token |
productCode * | string | 产品编码 |
请求示例
GET /api/code/email?token=YOUR_API_TOKEN&productCode=GMAIL_CODE
响应示例
Success
{
"code": 0,
"message": "SUCCESS",
"data": {
"uid": "ORD20250102001",
"account": "example@gmail.com",
"url": "https://api.xxx.com/..."
}
}
Error
{
"code": 101,
"message": "Insufficient stock",
"data": null
}
状态码
响应格式:code=0 表示成功,code≠0 表示失败,message 字段包含错误信息
101库存不足204请联系客服激活产品权限401余额不足
GET
/api/code/fetch获取验证码
根据订单号获取已接收到的验证码,可能需要轮询直到收到验证码
请求参数
token * | string | API Token |
uid * | string | 订单号(从获取邮箱接口返回) |
codetime | int | 验证码保留时间(秒)。在设置的有效期内重复请求返回同一验证码;超时后不再返回;若此期间收到新验证码,则返回最新的 |
请求示例
GET /api/code/fetch?token=YOUR_API_TOKEN&uid=ORD20250102001
响应示例
Success
{
"code": 0,
"message": "SUCCESS",
"data": {
"code": "123456"
}
}
Error
{
"code": 601,
"message": "Waiting for verification code",
"data": null
}
状态码
响应格式:code=0 表示成功,code≠0 表示失败,message 字段包含错误信息
502订单不存在503订单已退款601等待验证码602账号不可用
GET
/api/account/email获取账号邮箱
获取一个完整的邮箱账号,包含密码和恢复邮箱
请求参数
token * | string | API Token |
productCode * | string | 产品编码 |
请求示例
GET /api/account/email?token=YOUR_API_TOKEN&productCode=GMAIL_ACCOUNT
响应示例
Success
{
"code": 0,
"message": "SUCCESS",
"data": {
"uid": "ORD20250102001",
"account": "example@gmail.com",
"password": "abc123",
"recoverAccount": "recover@...",
"text": "example@gmail.com----..."
}
}
Error
{
"code": 101,
"message": "Insufficient stock",
"data": null
}
状态码
响应格式:code=0 表示成功,code≠0 表示失败,message 字段包含错误信息
101库存不足204请联系客服激活产品权限401余额不足
GET
/api/user/balance获取余额
查询当前账户积分余额
请求参数
token * | string | API Token |
请求示例
GET /api/user/balance?token=YOUR_API_TOKEN
响应示例
Success
{
"code": 0,
"message": "SUCCESS",
"data": {
"username": "xxxxx",
"balance": 94686.294
}
}
状态码
响应格式:code=0 表示成功,code≠0 表示失败,message 字段包含错误信息
错误代码
响应格式:code=0 表示成功,code≠0 表示失败,message 字段包含错误信息
101 | 库存不足 |
204 | 请联系客服激活产品权限 |
401 | 余额不足 |
502 | 订单不存在 |
503 | 订单已退款 |
601 | 等待验证码 |
602 | 账号不可用 |
代码示例
JavaScript (Node.js)
// Step 1: Get verification code email
const emailRes = await fetch('https://gapi.mailsapi.com/api/code/email?token=YOUR_API_TOKEN&productCode=GMAIL_CODE');
const emailData = await emailRes.json();
if (emailData.code === 0) {
console.log('Email:', emailData.data.account);
console.log('UID:', emailData.data.uid);
// Step 2: Fetch verification code (poll until received)
const fetchCode = async () => {
const codeRes = await fetch(`https://gapi.mailsapi.com/api/code/fetch?token=YOUR_API_TOKEN&uid=${emailData.data.uid}`);
const codeData = await codeRes.json();
if (codeData.code === 0 && codeData.data.code) {
console.log('Verification Code:', codeData.data.code);
return codeData.data.code;
}
// Wait and retry if code not yet available
await new Promise(r => setTimeout(r, 3000));
return fetchCode();
};
await fetchCode();
}
Python
import requests
import time
API_TOKEN = 'YOUR_API_TOKEN'
BASE_URL = 'https://gapi.mailsapi.com'
# Step 1: Get verification code email
email_res = requests.get(f'{BASE_URL}/api/code/email', params={
'token': API_TOKEN,
'productCode': 'GMAIL_CODE'
})
email_data = email_res.json()
if email_data['code'] == 0:
print(f"Email: {email_data['data']['account']}")
uid = email_data['data']['uid']
# Step 2: Fetch verification code (poll until received)
while True:
code_res = requests.get(f'{BASE_URL}/api/code/fetch', params={
'token': API_TOKEN,
'uid': uid
})
code_data = code_res.json()
if code_data['code'] == 0 and code_data['data'].get('code'):
print(f"Verification Code: {code_data['data']['code']}")
break
time.sleep(3) # Wait 3 seconds before retry