SelSup Developers
Қоғамдық API · API Анықтама
Орнатудың соңғы нүктелері, соның ішінде нақты бағыттар, параметрлер, сұрау салу органдары және кеңейтілетін жауап схемалары.
Бұл бетте өңдеуге жарамды жеке келісімшарт бар. Өнімді пайдаланудан бұрын сынақ деректерімен жазу операцияларын растаңыз.
/api/property
Қолдануға дайын жұмыс барысы
API токенін пайдаланып, оқу операцияларын бірінші кезекте тест деректерімен растаңыз.
Деректер моделі
Модельдер бір рет осы жерде тізімделеді және оларды пайдаланатын соңғы нүктелерден тікелей кеңейтілуі мүмкін.
organizationIdinteger · int64Ұйымның жеке куәлігі.
clientIdinteger · int64Клиент танымдығы.
read-onlycomponentstringҚұрамында.
namestringЕсім.
valuestringҚұндылығы.
valueNamestringҚұндылық атауы.
Қате туралы келісімшарт
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/property/PUT /api/property/. арқылы қасиеттерді орнату
application/jsonProperty| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
organizationId |
integer · int64 | Жоқ | Ұйымның жеке куәлігі. |
clientId |
integer · int64 | Жоқ | Клиент танымдығы. |
component |
string | Жоқ | Құрамында. |
name |
string | Жоқ | Есім. |
value |
string | Жоқ | Құндылығы. |
valueName |
string | Жоқ | Құндылық атауы. |
curl --request PUT 'https://api.selsup.ru/api/property/' \
--header 'Authorization: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}'const response = await fetch('https://api.selsup.ru/api/property/', {
method: 'PUT',
headers: {
Authorization: process.env.SELSUP_API_TOKEN,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}),
});
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/property/', {
method: 'PUT',
headers: {
Authorization: process.env.SELSUP_API_TOKEN!,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}),
});
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.put(
'https://api.selsup.ru/api/property/',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
json={
'organizationId': 1001,
'clientId': 1001,
'component': 'string',
'name': 'Example',
'value': 'string',
'valueName': 'Example'
},
)
response.raise_for_status()<?php
$payload = <<<'JSON'
{
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}
JSON;
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/property/',
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN'), 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => $payload,
]);
$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"
"strings"
)
func main() {
req, err := http.NewRequest("PUT", "https://api.selsup.ru/api/property/", strings.NewReader(`{
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}`))
if err != nil { panic(err) }
req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))
req.Header.Set("Content-Type", "application/json")
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/property/"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.header("Content-Type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("""
{
"organizationId": 1001,
"clientId": 1001,
"component": "string",
"name": "Example",
"value": "string",
"valueName": "Example"
}
"""))
.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_invalid_currency_sourceАяқ нүктесі error. Қолданба логикада error_invalid_currency_source тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_no_clientАяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
/api/property/{organizationId}/{component}GET /api/property/{organizationId}/{component}. пайдалануды қолға алыңыз
| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
organizationId |
integer · int64 | Иә | Ұйымның жеке куәлігі. |
component |
string | Иә | Құрамында. |
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/property/1001/string', {
method: 'GET',
headers: { Authorization: process.env.SELSUP_API_TOKEN },
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || 'selsup_request_failed');
}
const result = await response.json();const response: Response = await fetch('https://api.selsup.ru/api/property/1001/string', {
method: 'GET',
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');
}
const result: unknown = await response.json();import os
import requests
response = requests.get(
'https://api.selsup.ru/api/property/1001/string',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/property/1001/string',
CURLOPT_CUSTOMREQUEST => 'GET',
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("GET", "https://api.selsup.ru/api/property/1001/string", 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/property/1001/string"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}"string"Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑
auth_requiredAuthorization жоқ, бос немесе жарамсыз белгісі бар.
error_access_deniedТокен бар, бірақ оның рөлі бұл операцияны орындай алмайды.
error_unknownІшкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.
error_header_logo_upload_failedАяқ нүктесі error. Қолданба логикада error_header_logo_upload_failed тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_no_clientАяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_ozon_fbo_workflow_not_foundАяқ нүктесі error. Қолданба логикада error_ozon_fbo_workflow_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
error_user_does_not_have_this_organizationАяқ нүктесі error. Қолданба логикада error_user_does_not_have_this_organization тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.
/api/property/list/{component}GET /api/property/list/{component}. қолданылған тізім
| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
component |
string | Иә | Құрамында. |
| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
organizationId |
integer · int64 | Жоқ | Ұйымның жеке куәлігі. |
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/property/list/string', {
method: 'GET',
headers: { Authorization: process.env.SELSUP_API_TOKEN },
});
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || 'selsup_request_failed');
}
const result = await response.json();const response: Response = await fetch('https://api.selsup.ru/api/property/list/string', {
method: 'GET',
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');
}
const result: unknown = await response.json();import os
import requests
response = requests.get(
'https://api.selsup.ru/api/property/list/string',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/property/list/string',
CURLOPT_CUSTOMREQUEST => 'GET',
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("GET", "https://api.selsup.ru/api/property/list/string", 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/property/list/string"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Property[]
| Өріс | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
organizationId |
integer · int64 | Жоқ | Ұйымның жеке куәлігі. |
clientId |
integer · int64 | Жоқ | Клиент танымдығы. |
component |
string | Жоқ | Құрамында. |
name |
string | Жоқ | Есім. |
value |
string | Жоқ | Құндылығы. |
valueName |
string | Жоқ | Құндылық атауы. |
[
"string"
]Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑
auth_requiredAuthorization жоқ, бос немесе жарамсыз белгісі бар.
error_access_deniedТокен бар, бірақ оның рөлі бұл операцияны орындай алмайды.
error_unknownІшкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.
error_subscription_expiredАяқ нүктесі error. Қолданба логикада error_subscription_expired тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.