SelSup Developers
Коомдук API · API Сүрөт
Орнотуулар үчүн акыркы пункттар, анын ичинде так маршруттар, параметрлер, суроо-талап органдары жана кеңейтилген жооп схемалары.
Бул барак түзөтүлүүчү өз алдынча келишим менен камсыз кылынат.
/api/property
Колдонууга даяр жумуш жүрүштөрү
API белгисин колдонуп, биринчиден тесттик маалыматтар менен окуу операцияларын тастыктаңыз.
Маалыматтын модели
Бул жерде моделдер бир жолу көрсөтүлгөн жана аларды колдонгон акыркы пункттардан түздөн-түз кеңейтилген.
organizationIdinteger · int64Уюмдун идентификатору.
clientIdinteger · int64Кардар ID.
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 | Жок | Кардар ID. |
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_sourceEndpoint-specific error. Колдонмо логикасында туруктуу error_invalid_currency_source кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.
error_no_clientEndpoint-specific 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_failedEndpoint-specific error. Колдонмо логикасында туруктуу error_header_logo_upload_failed кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.
error_no_clientEndpoint-specific error. Колдонмо логикасында туруктуу error_no_client кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.
error_ozon_fbo_workflow_not_foundEndpoint-specific error. Колдонмо логикасында туруктуу error_ozon_fbo_workflow_not_found кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.
error_user_does_not_have_this_organizationEndpoint-specific 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 | Жок | Кардар ID. |
component |
string | Жок | Компонент. |
name |
string | Жок | Аты. |
value |
string | Жок | Баасы. |
valueName |
string | Жок | Баасы - Аты. |
[
"string"
]Колдонмо каталары JSON, error жана params менен JSON катары кайтарылат. error тармагы; жергиликтүү текст өзгөрүшү мүмкүн. Колдонмо каталарын кантип кайтаруу керек ↑
auth_requiredAuthorization жок, бош же жараксыз белгиси бар.
error_access_deniedТокен бар, бирок анын ролу бул операцияны аткара албайт.
error_unknownИчки бузулуу. Суроо убактысын жана байланыш колдоосун үнөмдөө; мутацияны кайрадан сокурдук менен аракет кылбаңыз.
error_subscription_expiredEndpoint-specific error. Колдонмо логикасында туруктуу error_subscription_expired кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.