SelSup Developers
Грамадскае API · API Падпісанне
Канчатковыя пункты для налад, уключаючы дакладныя маршруты, параметры, органы запыту і схемы адказу, якія могуць быць пашыраны.
Гэты старонка падтрымліваецца рэдагаваць самастойны кантракт.
/api/property
Готовыя да выкарыстання працоўныя патокі
Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.
Мадэль дадзеных
Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.
organizationIdinteger · int64Ід арганізацыі.
clientIdinteger · int64Ідэнтыфікатар кліента.
read-onlycomponentstringКампанент.
namestringНазва.
valuestringЗначэнне.
valueNamestringЗначэнне імя.
Памылка дагавор
Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.
errorСтабільны машыначытай код для інтэграцыйнай логікі.
localMessageПаведамленне гатовае да адлюстравання на мове карыстальніка токены API.
paramsЗначэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.
localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак 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, localMessage і params. Як вяртаюць памылкі прыкладання ↑
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑
auth_requiredAuthorization не хапае, пусты, або ўтрымлівае недаступны токен.
error_access_deniedТокен існуе, але яго роля не можа выканаць гэтую аперацыю.
error_unknownУнутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
error_subscription_expiredСпецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_subscription_expired ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.