开始使用媒体
使用专用API代币,首先验证测试数据的读取操作.
- 保存代币服务器侧,然后将其发送到Authorization标题中.
- 检查所需参数,并扩大请求或响应方案.
- 在应用错误中处理HTTP状态和稳定的error字段.
通过可编辑的独立合同来支持本页面. 在生产使用之前,验证使用测试数据的写作操作.
/api/media/order/{orderId}/video
准备使用的工作流程
准备使用的工作流程
数据模型
数据结构
模型在此列出一次,并且可以直接从使用它们的终端点扩展.
错误合同
如何返回应用错误
编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在error周围的应用逻辑,仅用于显示.
鱼类稳定机器可读的代码用于集成逻辑.
鱼类在API代币用户语言中显示准备的消息.
鱼类服务器在本地化消息模板中插入的值.
文
localMessage使用了 API代币的用户的lang字段.文档语言和 Accept-Language标题不会改变它;当用户没有语言配置时,使用俄语.
RU用户位置是 ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}CN中文 (cn)
{
"error": "error_brand_already_exists",
"localMessage": "品牌 Base 已经存在",
"params": {
"name": "Base"
}
}终点
终点
POST
上传订单 收集视频
/api/media/order/{orderId}/video具有写入的标志
使用 POST 上传命令收集视频
路径参数
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
orderId |
integer · int64 | 是 | 订单身份证. |
curl --request POST 'https://api.selsup.ru/api/media/order/1001/video' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/media/order/1001/video', {
method: 'POST',
headers: { Authorization: process.env.SELSUP_API_TOKEN },
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || 'selsup_request_failed');
}const response: Response = await fetch('https://api.selsup.ru/api/media/order/1001/video', {
method: 'POST',
headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});
if (!response.ok) {
const error = await response.json() as { error?: string };
throw new Error(error.error ?? 'selsup_request_failed');
}import os
import requests
response = requests.post(
'https://api.selsup.ru/api/media/order/1001/video',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/media/order/1001/video',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($response === false || $status >= 400) {
throw new RuntimeException($response ?: 'selsup_request_failed');
}
echo $response;package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("POST", "https://api.selsup.ru/api/media/order/1001/video", nil)
if err != nil { panic(err) }
req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
response, err := http.DefaultClient.Do(req)
if err != nil { panic(err) }
defer response.Body.Close()
result, _ := io.ReadAll(response.Body)
fmt.Printf("%d\n%s\n", response.StatusCode, result)
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class SelSupExample {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/media/order/1001/video"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}成功的反应
200答案没有身体.
错误6
应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑
401
auth_required需要进行认证
Authorization 缺失,空,或包含无效的代币.
400
error_access_denied拒绝访问
代币存在,但它的作用不能执行这个操作.
500
error_unknown发生了一个未知的错误。如果该问题再次发生，请联系支持
节省请求时间和联系支持;不要盲目重新尝试突变.
400
error_no_client没有找到该客户或已被删除。写信给支持部门
应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.
400
error_order_not_found未找到订单
应用逻辑中使用稳定的error_order_not_found代码;localMessage包含上述翻译.
400
error_storage_size_exceeded你已经超过了文件存储限制： {limit} MB
应用逻辑中使用稳定的error_storage_size_exceeded代码;localMessage包含上述翻译.