SelSup Developers
Публичный API · Справочник API
Создание, просмотр и удаление подписок на уведомления об изменениях в SelSup.
Подпишите свой сервер на нужные события. SelSup отправит POST-запрос на сохранённый адрес, когда изменится заказ или доступный остаток. Проверяйте подпись каждого уведомления перед обработкой.
/api/webhook
Примеры использования
Настройте обработчик, подпишитесь на CREATE_ORDER и проверьте уведомление на тестовом заказе.
Модель данных
Эти поля описывают настройки подписки. Формат самого уведомления зависит от выбранного события и приведён в руководстве по вебхукам.
idinteger · int32Идентификатор подписки, который SelSup присваивает после создания.
namestringНазвание для различения подписок, например «Заказы для WMS».
urlstringПубличный адрес вашего обработчика. На него SelSup отправляет POST-запросы.
typesstring[]Массив типов событий: CREATE_ORDER, ORDER, ORDER_STATUS, CREATE_PRODUCT или STOCK.
clientIdinteger · int64Идентификатор кабинета, которому принадлежит подписка. Определяется по авторизации.
organizationIdinteger · int64Ограничение по организации для событий заказов. Без значения подписка принимает заказы разных организаций кабинета.
signingSecretstringСекрет проверки подписи X-SelSup-Signature. Возвращается при создании и просмотре подписок; храните его на сервере.
read-onlyОшибки
При ошибке API возвращает её код в поле error и сообщение на языке пользователя в localMessage. Проверяйте код error в программе, а localMessage показывайте пользователю.
errorКод ошибки для обработки в программе.
localMessageСообщение на языке пользователя, которому принадлежит токен.
paramsЗначения, которые сервер подставил в сообщение об ошибке.
Язык localMessage определяется полем lang пользователя, которому принадлежит API-токен. Язык страницы документации и заголовок Accept-Language его не переключают; если язык пользователя не указан, используется русский.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "Brand Base already exists",
"params": {
"name": "Base"
}
}Методы
/api/webhook/Возвращает подписки текущего кабинета вместе с секретами подписи. Доступен сотрудникам с правами ADMIN или API.
curl --request GET 'https://api.selsup.ru/api/webhook/' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/webhook/', {
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/webhook/', {
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/webhook/',
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/webhook/',
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/webhook/", 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/webhook/"))
.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());
}
}Webhook[]
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор подписки, который SelSup присваивает после создания. |
name |
string | Нет | Название для различения подписок, например «Заказы для WMS». |
url |
string | Нет | Публичный адрес вашего обработчика. На него SelSup отправляет POST-запросы. |
types |
string[] | Нет | Массив типов событий: CREATE_ORDER, ORDER, ORDER_STATUS, CREATE_PRODUCT или STOCK. |
clientId |
integer · int64 | Нет | Идентификатор кабинета, которому принадлежит подписка. Определяется по авторизации. |
organizationId |
integer · int64 | Нет | Ограничение по организации для событий заказов. Без значения подписка принимает заказы разных организаций кабинета. |
signingSecret |
string | Нет | Секрет проверки подписи X-SelSup-Signature. Возвращается при создании и просмотре подписок; храните его на сервере. |
[
{
"id": 1001,
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
],
"clientId": 1001,
"signingSecret": "0000000000000000000000000000000000000000000000000000000000000000"
}
]При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownНе удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.
error_subscription_expiredДля работы с подписками требуется действующий тариф. После оплаты повторите запрос.
/api/webhook/Принимает адрес обработчика и непустой массив типов событий. SelSup создаёт отдельный секрет подписи и возвращает сохранённую подписку. Для событий заказов можно ограничить отправку по organizationId.
application/jsonWebhook| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор подписки, который SelSup присваивает после создания. |
name |
string | Нет | Название для различения подписок, например «Заказы для WMS». |
url |
string | Нет | Публичный адрес вашего обработчика. На него SelSup отправляет POST-запросы. |
types |
string[] | Нет | Массив типов событий: CREATE_ORDER, ORDER, ORDER_STATUS, CREATE_PRODUCT или STOCK. |
clientId |
integer · int64 | Нет | Идентификатор кабинета, которому принадлежит подписка. Определяется по авторизации. |
organizationId |
integer · int64 | Нет | Ограничение по организации для событий заказов. Без значения подписка принимает заказы разных организаций кабинета. |
signingSecret |
string | Нет | Секрет проверки подписи X-SelSup-Signature. Возвращается при создании и просмотре подписок; храните его на сервере. |
curl --request POST 'https://api.selsup.ru/api/webhook/' \
--header 'Authorization: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}'const response = await fetch('https://api.selsup.ru/api/webhook/', {
method: 'POST',
headers: {
Authorization: process.env.SELSUP_API_TOKEN,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}),
});
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/webhook/', {
method: 'POST',
headers: {
Authorization: process.env.SELSUP_API_TOKEN!,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}),
});
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.post(
'https://api.selsup.ru/api/webhook/',
headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
json={
'name': 'Orders for WMS',
'url': 'https://integration.example.com/selsup/orders',
'types': [
'CREATE_ORDER'
]
},
)
response.raise_for_status()
result = response.json()<?php
$payload = <<<'JSON'
{
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}
JSON;
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.selsup.ru/api/webhook/',
CURLOPT_CUSTOMREQUEST => 'POST',
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("POST", "https://api.selsup.ru/api/webhook/", strings.NewReader(`{
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}`))
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/webhook/"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
]
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Webhook
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id |
integer · int32 | Нет | Идентификатор подписки, который SelSup присваивает после создания. |
name |
string | Нет | Название для различения подписок, например «Заказы для WMS». |
url |
string | Нет | Публичный адрес вашего обработчика. На него SelSup отправляет POST-запросы. |
types |
string[] | Нет | Массив типов событий: CREATE_ORDER, ORDER, ORDER_STATUS, CREATE_PRODUCT или STOCK. |
clientId |
integer · int64 | Нет | Идентификатор кабинета, которому принадлежит подписка. Определяется по авторизации. |
organizationId |
integer · int64 | Нет | Ограничение по организации для событий заказов. Без значения подписка принимает заказы разных организаций кабинета. |
signingSecret |
string | Нет | Секрет проверки подписи X-SelSup-Signature. Возвращается при создании и просмотре подписок; храните его на сервере. |
{
"id": 1001,
"name": "Orders for WMS",
"url": "https://integration.example.com/selsup/orders",
"types": [
"CREATE_ORDER"
],
"clientId": 1001,
"signingSecret": "0000000000000000000000000000000000000000000000000000000000000000"
}При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownНе удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.
error_empty_typeМассив types отсутствует, пуст или содержит null. Передайте хотя бы один поддерживаемый тип события.
error_empty_urlВ поле url не указан адрес обработчика или переданы только пробелы.
error_invalid_urlПроверьте публичный адрес обработчика и его длину: допускается не более 200 символов. Локальные и запрещённые адреса не принимаются.
error_subscription_expiredДля работы с подписками требуется действующий тариф. После оплаты повторите запрос.
/api/webhook/{webhookId}Прекращает отправку уведомлений по этой подписке. Уже полученные сообщения в вашей системе остаются.
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
webhookId |
integer · int64 | Да | Идентификатор подписки из ответа создания или списка. |
curl --request DELETE 'https://api.selsup.ru/api/webhook/1001' \
--header 'Authorization: YOUR_API_TOKEN'const response = await fetch('https://api.selsup.ru/api/webhook/1001', {
method: 'DELETE',
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/webhook/1001', {
method: 'DELETE',
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.delete(
'https://api.selsup.ru/api/webhook/1001',
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/webhook/1001',
CURLOPT_CUSTOMREQUEST => 'DELETE',
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("DELETE", "https://api.selsup.ru/api/webhook/1001", 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/webhook/1001"))
.header("Authorization", System.getenv("SELSUP_API_TOKEN"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Тело ответа пустое.
При ошибке проверьте HTTP-статус и тело ответа. Поле error содержит код ошибки, localMessage — сообщение для пользователя, params — дополнительные сведения. Обработка ошибок ↑
auth_requiredЗаголовок Authorization отсутствует, пуст или содержит недействительный токен.
error_access_deniedТокен существует, но его роль не позволяет выполнить операцию.
error_unknownНе удалось выполнить запрос из-за внутренней ошибки. Если запрос изменял данные, проверьте результат перед повторной отправкой. Для обращения в поддержку сохраните время запроса и полученный ответ.
error_subscription_expiredДля работы с подписками требуется действующий тариф. После оплаты повторите запрос.