SelSup Developers
Public API · API Referencja
Punkty końcowe dla mediów, w tym dokładne trasy, parametry, organy żądania oraz rozszerzalne schematy odpowiedzi.
Strona ta jest wspierana przez edytowalny samodzielny kontrakt.
/api/media/order/{orderId}/video
Gotowe do użytkowania przepływy robocze
Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.
Model danych
Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.
Umowa o błędzie
Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.
errorStabilny kod czytelny maszynowo do logiki integracyjnej.
localMessagePrzesłanie gotowe do wyświetlania w języku użytkownika tokenu API.
paramsWartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.
localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "Marka Base już istnieje",
"params": {
"name": "Base"
}
}Punkty końcowe
/api/media/order/{orderId}/videoWstępuj do wideo z wykorzystaniem POST /api/media/order/{orderId}/video.
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
orderId |
integer · int64 | Tak | Identyfikacja zamówienia. |
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());
}
}Odpowiedź nie ma ciała.
błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑
auth_requiredAuthorization brakuje, jest puste lub zawiera nieważny token.
error_access_deniedToken istnieje, ale jego rola nie może wykonywać tej operacji.
error_unknownNie próbuj ponownie mutacji.
error_no_clienterror specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
error_order_not_founderror specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_order_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
error_storage_size_exceedederror specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_storage_size_exceeded; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.