API文档

App.apiDescription

入门

要使用YTMP3CV.COM API，您需要一个API密钥。如果您还没有，请联系我们以开始使用。

所有API请求应发送到以下基本URL：

https://api.ytmp3cv.com/

身份验证

在所有请求的标头中包含您的API密钥：

Authorization: Bearer YOUR_API_KEY

端点

将YouTube转换为MP3

POST /convert

将YouTube视频转换为MP3格式。

参数

名称 类型 描述
url string YouTube视频URL
quality string 可选。音频质量（高、中、低）。默认：高

示例请求


import requests

api_key = 'YOUR_API_KEY'
headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

data = {
    'url': 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
    'quality': 'high'
}

response = requests.post('https://api.ytmp3cv.com/convert', headers=headers, json=data)

if response.status_code == 200:
    result = response.json()
    print(f"Download URL: {result['download_url']}")
else:
    print(f"Error: {response.status_code}")

获取转换状态

GET /status/{conversion_id}

检查转换作业的状态。

参数

名称 类型 描述
conversion_id string 转换作业的ID

示例请求


import requests

api_key = 'YOUR_API_KEY'
headers = {
    'Authorization': f'Bearer {api_key}'
}

conversion_id = 'abc123'
response = requests.get(f'https://api.ytmp3cv.com/status/{conversion_id}', headers=headers)

if response.status_code == 200:
    result = response.json()
    print(f"Status: {result['status']}")
    print(f"Progress: {result['progress']}%")
else:
    print(f"Error: {response.status_code}")

批量转换

POST /batch-convert

在单个请求中将多个YouTube视频转换为MP3格式。

参数

名称 类型 描述
urls array YouTube视频URL数组
quality string 可选。音频质量（高、中、低）。默认：高

示例请求


import requests

api_key = 'YOUR_API_KEY'
headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

data = {
    'urls': [
        'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
        'https://www.youtube.com/watch?v=9bZkp7q19f0'
    ],
    'quality': 'high'
}

response = requests.post('https://api.ytmp3cv.com/batch-convert', headers=headers, json=data)

if response.status_code == 200:
    result = response.json()
    for job in result['jobs']:
        print(f"Conversion ID: {job['conversion_id']}")
else:
    print(f"Error: {response.status_code}")

速率限制

为确保公平使用并维护服务质量，我们的API实施了速率限制。当前限制为：

时间框架 请求限制
每分钟 100 requests
每小时 1,000 requests
每天 10,000 requests

如果您超过这些限制，您将收到429 Too Many Requests响应。响应将包括以下标头：

  • X-RateLimit-Limit: 该请求的速率限制上限
  • X-RateLimit-Remaining: 时间窗口内剩余的请求数
  • X-RateLimit-Reset: 速率限制重置前的剩余时间（以UTC纪元秒为单位）

如需针对您特定用例的更高速率限制，请联系我们的销售团队。

错误处理

描述

代码 描述
200 OK 请求成功。
400 Bad Request 请求无效或无法提供服务。错误消息中解释了具体错误。
401 Unauthorized 请求需要用户身份验证。
403 Forbidden 服务器理解请求但拒绝授权。
404 Not Found 找不到请求的资源。
429 Too Many Requests 您在给定时间内发送了太多请求。
500 Internal Server Error 我们的服务器出现问题。请稍后再试。

所有错误响应将在响应正文中包含具有以下结构的JSON对象：


{
    "error": {
        "code": "ERROR_CODE",
        "message": "A human-readable error message"
    }
}

我们建议在您的应用程序中实施适当的错误处理，以优雅地管理这些场景并提供流畅的用户体验。

开始使用我们的API

准备将我们强大的YouTube到MP3转换集成到您的应用程序中？

联系销售