SelSup Developers
Қоғамдық API · API Анықтама
Медиа үшін соңғы нүктелер, соның ішінде нақты бағыттар, параметрлер, сұрау салу органдары және кеңейтілетін жауап схемалары.
Бұл бетте өңдеуге жарамды жеке келісімшарт бар. Өнімді пайдаланудан бұрын сынақ деректерімен жазу операцияларын растаңыз.
/api/media/order/{orderId}/video
Қолдануға дайын жұмыс барысы
API токенін пайдаланып, оқу операцияларын бірінші кезекте тест деректерімен растаңыз.
Деректер моделі
Модельдер бір рет осы жерде тізімделеді және оларды пайдаланатын соңғы нүктелерден тікелей кеңейтілуі мүмкін.
Қате туралы келісімшарт
error коды барлық жерлерде бірдей, ал пайдаланушымен бетпе-бет сөйлейтін хабарлама сервер арқылы аударылады. error-ге арналған қолданба логикасын құру және localMessage-ді көрсету үшін ғана пайдалану.
errorИнтеграциялық логика үшін тұрақты машина оқуға болатын код.
localMessageAPI белгі пайдаланушы тілінде көрсетілуге дайын хабарлама.
paramsСервердің жергілікті хабарлама үлгісіне интерполациялаған мәндері.
localMessage API белгісін иеленуші пайдаланушының lang өрісін пайдаланады. Құжаттама тілі мен Accept-Language баған оны өзгертпейді; орыс тілі пайдаланушының тілі конфигурацияланбаған кезде қолданылады.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "Base бренді бұрыннан бар",
"params": {
"name": "Base"
}
}Аяқ нүктелері
/api/media/order/{orderId}/videoPOST /api/media/order/{orderId}/video. арқылы жүктеу тапсырысын жинаңыз
| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
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());
}
}Жауаптың денесі жоқ.
Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑
auth_requiredAuthorization жоқ, бос немесе жарамсыз белгісі бар.
error_access_deniedТокен бар, бірақ оның рөлі бұл операцияны орындай алмайды.
error_unknownІшкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.
error_no_clientАяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_order_not_foundАяқ нүктесі error. Қолданба логикада error_order_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_storage_size_exceededАяқ нүктесі error. Қолданба логикада error_storage_size_exceeded тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.