基础信息
查看接口基本信息和返回格式
免责声明
接口描述
支持音乐每日签到、守护签到、金币中心签到、会员签到;
七日请求统计
接口地址
https://api.yunmge.com/api/qmusic-signin
请求方式
返回方式
返回预览
[]
计费标准
了解接口计费方式和套餐价格
接口类型
免费接口:本接口对所有用户免费开放,每日有一定免费调用次数,超出后可继续使用或升级会员。
计费方式
QPS限制
每分钟最多30次请求,每秒最多1次请求
每分钟最多60次请求,每秒最多5次请求
每日请求次数
普通用户不限制每日请求次数
会员用户不限制每日请求次数
计费规则
安全认证
了解接口的认证方式和访问凭证管理
实名认证
本接口对所有用户开放,无需实名认证即可访问
认证方式
通过 HTTP Header 传递认证信息
通过 URL 参数传递认证信息
Token 管理
登录账户
使用您的账号密码登录平台,获取用户凭证
获取 Token
即可查看你的 Token 密钥
更换 Token
进入个人中心,点击「更换Token」,系统将生成新的 Token 密钥
保存 Token
请妥善保管您的 Token 密钥,泄露时请立即更换
Token 怪谈
安全建议
- 定期更换密钥,建议每 90 天更新一次
- 发现密钥泄露,请立即在个人中心「更换」该密钥
- 不要将密钥硬编码在代码中,使用环境变量存储
参数文档
了解接口的请求参数和响应字段说明
请求参数
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | music | music | 音乐每日签到 |
uin |
string | 否 | 无 | 登录返回的 uin | 不传返回已绑定账号列表;必须先通过 音乐登录接口绑定 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | guard | guard | 守护签到 |
uin |
string | 否 | 无 | 登录返回的 uin | 不传返回已绑定账号列表 |
medal_id |
string | 否 | 无 | 勋章 ID | 不传签所有可用勋章 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | coin | coin | 金币中心签到 + 签到奖励 |
uin |
string | 否 | 无 | 登录返回的 uin | 不传返回已绑定账号列表 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | vip | vip | 会员签到 |
uin |
string | 否 | 无 | 登录返回的 uin | 不传返回已绑定账号列表 |
| 参数名 | 类型 | 必填 | 默认值 | 可选值 | 说明 |
|---|---|---|---|---|---|
type |
string | 是 | all | all | 依次执行 音乐 / 守护 / 金币 / 会员签到 |
uin |
string | 否 | 无 | 登录返回的 uin | 不传返回已绑定账号列表 |
响应参数
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 签到数据 |
|
│
├─
type
|
string | music |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
success
|
int | 是否成功 |
|
│
result
|
object | 签到结果 |
|
│
│
├─
signed
|
int | 是否已签到 |
|
│
│
├─
already
|
int | 是否今日已签 |
|
│
│
├─
msg
|
string | 结果说明 |
|
│
│
├─
month
|
string | 签到月份 |
|
│
│
├─
card
|
object | 今日卡片 |
|
│
│
└─
cards
|
array | 本月卡片 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 签到数据 |
|
│
├─
type
|
string | guard |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
success
|
bool | 是否成功 |
|
│
result
|
object | 签到结果 |
|
│
│
├─
code
|
int | 状态码 |
|
│
│
├─
msg
|
string | 结果说明 |
|
│
│
data
|
object | 守护数据 |
|
│
│
│
├─
ok
|
int | 成功数量 |
|
│
│
│
├─
total
|
int | 可签数量 |
|
│
│
│
results
|
array | 每个勋章结果 |
|
│
│
│
│
├─
medal_id
|
string | 勋章 ID |
|
│
│
│
│
├─
name
|
string | 勋章名 |
|
│
│
│
│
├─
status
|
string | ok / already / skip / failed |
|
│
│
│
│
├─
msg
|
string | 结果说明 |
|
│
│
│
│
├─
fan_value
|
int | 乐迷值增量 |
|
│
│
│
rewards
|
array | 宝箱奖励 |
|
│
│
│
│
├─
medal_id
|
string | 勋章 ID |
|
│
│
│
│
├─
name
|
string | 勋章名 |
|
│
│
│
│
├─
reward
|
string | 奖励名 |
|
│
│
│
│
└─
num
|
int | 数量 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 签到数据 |
|
│
├─
type
|
string | coin |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
success
|
bool | 是否成功 |
|
│
result
|
object | 签到结果 |
|
│
│
├─
code
|
int | 状态码 |
|
│
│
├─
msg
|
string | 结果说明 |
|
│
│
data
|
object | 金币数据 |
|
│
│
│
├─
signed
|
bool | 是否已签 |
|
│
│
│
├─
continue_days
|
int | 连续签到天数 |
|
│
│
│
├─
coin_balance
|
int | 金币余额 |
|
│
│
│
├─
awarded
|
int | 领取奖励数 |
|
│
│
│
└─
messages
|
array | 签到/奖励明细 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 提示信息 |
data
|
object | 签到数据 |
|
│
├─
type
|
string | vip |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
success
|
bool | 是否成功/已跳过 |
|
│
result
|
object | 会员结果 |
|
│
│
├─
code
|
int | 状态码 |
|
│
│
├─
msg
|
string | 结果说明 |
|
│
│
data
|
object | 会员数据 |
|
│
│
│
├─
vip
|
bool | 是否会员 |
|
│
│
│
├─
skipped
|
bool | 是否跳过 |
|
│
│
│
├─
already
|
bool | 今日是否已签 |
|
│
│
│
├─
already
|
bool | 今日是否已签 |
|
│
│
│
├─
success
|
bool | 是否成功 |
|
│
│
│
rewards
|
array | 签到奖励 |
|
│
│
│
│
├─
type
|
string | score / coupon |
|
│
│
│
│
└─
msg
|
string | 奖励说明 |
| 字段名 | 类型 | 说明 |
|---|---|---|
code
|
int | 状态码 |
msg
|
string | 汇总提示 |
data
|
object | 汇总数据 |
|
│
├─
uin
|
string | 账号标识 |
|
│
├─
ok
|
int | 实际签到成功类型数 |
|
│
├─
skipped
|
int | 自动跳过类型数 |
|
│
├─
total
|
int | 总类型数(3) |
|
│
results
|
object | 各类型结果 |
|
│
│
music
|
object | 音乐签到结果 |
|
│
│
│
├─
code
|
int | 状态码 |
|
│
│
│
├─
msg
|
string | 结果说明 |
|
│
│
guard
|
object | 守护签到结果 |
|
│
│
│
├─
code
|
int | 状态码 |
|
│
│
│
├─
msg
|
string | 结果说明 |
|
│
│
│
├─
data
|
object | 守护数据 |
|
│
│
coin
|
object | 金币签到结果 |
|
│
│
│
├─
code
|
int | 状态码 |
|
│
│
│
├─
msg
|
string | 结果说明 |
|
│
│
vip
|
object | 会员签到结果 |
|
│
│
│
├─
code
|
int | 状态码 |
|
│
│
│
└─
msg
|
string | 结果说明 |
状态码
了解接口返回的状态码含义及处理方式
接口状态码
| 状态码 | 说明 |
|---|---|
200 |
签到完成(全部签到或部分跳过;all 至少一项成功或跳过) |
201 |
签到失败(全部签到项失败或后端异常) |
400 |
参数错误(type / medal_id 不受支持或格式错误) |
401 |
未绑定音乐账号(需先登录并绑定) |
403 |
无权限操作该账号(只能操作当前 token 绑定的账号) |
服务器状态码
| 状态码 | 说明 |
|---|---|
500 |
服务器错误 |
501 |
请求接口不存在 |
502 |
请求接口已下架 |
503 |
请求接口维护中 |
504 |
缺少请求token参数 |
505 |
请求token不存在 |
506 |
请求token已被封禁 |
507 |
请求token额度不足 |
508 |
今日请求token已达上限 |
509 |
请求ip不在token白名单内 |
510 |
请求token无权使用当前接口 |
511 |
接口请求频率过高,请稍后再试 |
512 |
该接口未开启在线测试功能 |
513 |
今日在线测试次数已达上限 |
514 |
今日该接口请求次数已达上限 |
515 |
该接口为会员专属接口,请携带会员token |
516 |
该接口为会员专属接口,请开通会员 |
517 |
接口请求过于频繁,已被临时限制 |
518 |
该接口需要实名认证,请先完成实名认证 |
519 |
当前Token今日请求次数已达上限 |
520 |
当前Token已被禁止使用 |
521 |
请求token余额不足 |
522 |
请求token额度和余额均不足 |
530 |
接口服务异常,请稍后再试 |
531 |
接口响应超时,请稍后再试 |
532 |
接口暂时不可用,请稍后再试 |
533 |
接口配置异常 |
534 |
请求参数错误,请检查后重试 |
535 |
接口返回数据异常 |
在线测试
在线调试接口,实时查看响应结果
在线测试未开启
该接口暂未开启在线测试功能
示例代码
查看多种编程语言的接口调用示例
/**
* API请求DEMO-PHP
*
* 本demo支持GET与POST请求。
*/
//你申请的token密钥
$API_TOKEN = 'YOUR_TOKEN';
//API接口地址
$API_URL = 'https://api.yunmge.com/api/qmusic-signin';
$get_post_data = array(
'key' => 'value',
);
/*发起请求API接口:
第1个参数:API接口地址URL,跟上面的同名变量相对应,无需更改。
第2个参数:API接口参数数组,跟上面的同名变量相对应,无需更改。
第3个参数:请求协议(GET或POST),一般默认GET,部分接口需要POST请求,根据实际情况修改为POST即可。
*/
$resdata = api::send($API_URL, $get_post_data, 'GET/POST'); //发起请求,注意这里要选择接口支持的协议,默认GET,可选POST
//打印请求结果
print($resdata);
///////////////你的业务代码可写在这里处理API返回的数据
/**
* API请求类
*/
class api
{
public static function send($API_URL, $get_post_data, $type)
{
$get_post_data = http_build_query($get_post_data);
$res = self::send_curl($API_URL, $type, $get_post_data, null);
return $res;
}
//封装好的CURL请求函数,支持POST|GET
public static function send_curl($API_URL, $type, $get_post_data)
{
$ch = curl_init();
if ($type == 'POST') {
curl_setopt($ch, CURLOPT_URL, $API_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $get_post_data);
} elseif ($type == 'GET') {
curl_setopt($ch, CURLOPT_URL, $API_URL . '?' . $get_post_data);
}
curl_setopt($ch, CURLOPT_REFERER, $API_URL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$resdata = curl_exec($ch);
curl_close($ch);
return $resdata;
}
}
/**
* API请求DEMO-JavaScript
*
* 本demo支持GET与POST请求。
*/
//jQuery-Ajax
$.ajax({
url: 'https://api.yunmge.com/api/qmusic-signin',
data: {
key: 'value',
},
type: 'GET/POST', //请求协议(GET或POST),一般默认GET,部分接口需要POST请求,根据实际情况修改为POST即可。
dataType: 'json',
success: function(data) {
console.log(data); //请求成功,输出结果到控制台
},
timeout: 3000, //超时时间
error: function(data) {
console.log('请求失败'); //失败处理
}
});
/**
* API请求DEMO-NodeJs
*
* 本demo支持GET与POST请求。
*/
const https = require('https');
const querystring = require('querystring');
// 定义请求选项
const options = {
hostname: 'api.yunmge.com',
path: '/api/qmusic-signin',
method: 'GET/POST'
};
// 发送POST请求
const postData = querystring.stringify({
'key': 'value',
});
const postOptions = {
hostname: 'api.yunmge.com',
path: '/api/qmusic-signin',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': Buffer.byteLength(postData)
}
};
const postReq = https.request(postOptions, res => {
console.log(`statusCode: ${res.statusCode}`);
res.on('data', d => {
process.stdout.write(d);
});
});
postReq.on('error', error => {
console.error(error);
});
postReq.write(postData);
postReq.end();
import requests
url = "https://api.yunmge.com/api/qmusic-signin"
data = {
"key": "value",
}
response = requests.post(url, data=data)
print(response.json())
package main
import (
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strings"
)
func main() {
apiURL := "https://api.yunmge.com/api/qmusic-signin"
// POST请求
data := url.Values{}
data.Set("key", "value")
resp, err := http.Post(apiURL, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
if err != nil {
fmt.Println("请求失败:", err)
return
}
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
public class ApiRequest {
public static void main(String[] args) {
try {
String apiUrl = "https://api.yunmge.com/api/qmusic-signin";
URL url = new URL(apiUrl);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setDoOutput(true);
// 构建POST参数
StringBuilder postData = new StringBuilder();
postData.append("key=").append(URLEncoder.encode("value", "UTF-8"));
byte[] postDataBytes = postData.toString().getBytes("UTF-8");
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
try (OutputStream os = conn.getOutputStream()) {
os.write(postDataBytes);
}
BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
StringBuilder response = new StringBuilder();
while ((line = reader.readLine()) != null) {
response.append(line);
}
reader.close();
System.out.println(response.toString());
} catch (Exception e) {
e.printStackTrace();
}
}
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
class Program {
static async Task Main() {
string apiUrl = "https://api.yunmge.com/api/qmusic-signin";
using (HttpClient client = new HttpClient()) {
// POST请求
var formData = new Dictionary<string, string> {
{ "key", "value" },
};
var content = new FormUrlEncodedContent(formData);
HttpResponseMessage response = await client.PostAsync(apiUrl, content);
string result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
}
}
}
/**
* API请求DEMO-C
*
* 本demo支持GET与POST请求。
* 需要安装libcurl库
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h>
// API地址
const char* url = "https://api.yunmge.com/api/qmusic-signin";
// POST请求
void postRequest(CURL* curl) {
CURLcode res;
const char* postData = "key=value";
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, postData);
res = curl_easy_perform(curl);
if(res != CURLE_OK) {
fprintf(stderr, "curl_easy_perform() failed: %s\n", curl_easy_strerror(res));
}
}
int main() {
CURL* curl = curl_easy_init();
if(curl) {
postRequest(curl); curl_easy_cleanup(curl);
}
return 0;
}
/**
* API请求DEMO-C++
*
* 本demo支持GET与POST请求。
* 需要安装libcurl库
*/
#include <iostream>
#include <string>
#include <curl/curl.h>
int main() {
CURL* curl = curl_easy_init();
if(curl) {
std::string apiUrl = "https://api.yunmge.com/api/qmusic-signin";
// POST请求
std::string postData = "key=value";
curl_easy_setopt(curl, CURLOPT_URL, apiUrl.c_str());
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, postData.c_str());
CURLcode res = curl_easy_perform(curl);
if(res != CURLE_OK) {
std::cerr << "curl_easy_perform() failed: " << curl_easy_strerror(res) << std::endl;
}
curl_easy_cleanup(curl);
}
return 0;
}
.版本 2
.支持库 spec
.子程序 _启动子程序
.局部变量 url, 文本型
.局部变量 data, 文本型
.局部变量 result, 文本型
url = "https://api.yunmge.com/api/qmusic-signin"
data = "key=value"
result = 网页_访问 (url, 1, data, , , , , , , , , )
调试输出 (result)
常见问题
查找常见问题的解决方案
计费与注意事项
- 完全免费
常见问题
Q:type=all 会执行什么?
A:依次执行音乐签到、守护签到、金币中心签到、会员签到。
Q:非会员提交会员签到会报错吗?
A:不会。非会员的会员签到会自动跳过,不影响其它签到。
Q:守护签到怎么指定勋章?
A:传 medal_id 只签指定勋章;不传则签当前全部可用勋章。
Q:已经签到过会怎样?
A:返回今日已签到/已跳过,不会重复领取。
Q:签到奖励在哪里领?
A:签到后会自动领取对应奖励:守护赛季宝箱、会员每日积分和礼券、金币签到奖励;部分活动奖励仍需在音乐客户端领取。