SelSup Developers
API · API Đề xuất
Các điểm cuối cho Webhooks, bao gồm các tuyến đường chính xác, tham số, cơ quan yêu cầu và các chương trình phản hồi có thể mở rộng.
Trang này được hỗ trợ bởi một hợp đồng độc lập có thể chỉnh sửa. Thiết lập các hoạt động viết bằng dữ liệu thử nghiệm trước khi sử dụng sản xuất.
/api/webhook
Các dòng công việc sẵn sàng sử dụng
Sử dụng mã thông báo API chuyên dụng và xác nhận các hoạt động đọc bằng dữ liệu thử nghiệm trước.
Mô hình dữ liệu
Các mô hình được liệt kê một lần ở đây và cũng có thể được mở rộng trực tiếp từ các điểm cuối sử dụng chúng.
idinteger · int32Id.
namestringTên.
urlstringUrl.
typesstring[]Những loại.
clientIdinteger · int64- Đồ nhận khách hàng.
organizationIdinteger · int64Đơn vị tổ chức.
Hợp đồng lỗi
Mã error giống nhau ở mọi địa điểm, trong khi thông điệp đối diện người dùng được dịch bởi máy chủ. Xây dựng logic ứng dụng xung quanh error và sử dụng localMessage chỉ cho hiển thị.
errorMã máy tính có thể đọc ổn định cho logic tích hợp.
localMessageThông điệp sẵn sàng hiển thị trong ngôn ngữ của người dùng mã thông báo API.
paramsCác giá trị được máy chủ liên kết vào mẫu tin nhắn địa phương.
localMessage sử dụng trường lang của người dùng sở hữu mã thông báo API. Ngôn ngữ tài liệu và tiêu đề Accept-Language không thay đổi nó; tiếng Nga được sử dụng khi người dùng không có ngôn ngữ được cấu hình.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "Thương hiệu Base đã tồn tại",
"params": {
"name": "Base"
}
}Điểm cuối
/api/webhook/Danh sách sử dụng GET /api/webhook/.
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[]
| Trường | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id |
integer · int32 | Không | Id. |
name |
string | Không | Tên. |
url |
string | Không | Url. |
types |
string[] | Không | Những loại. |
clientId |
integer · int64 | Không | - Đồ nhận khách hàng. |
organizationId |
integer · int64 | Không | Đơn vị tổ chức. |
[
"string"
]Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
auth_requiredAuthorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
error_access_deniedCác token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
error_unknownThất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
error_subscription_expirederror cụ thể cho điểm cuối. Sử dụng mã error_subscription_expired ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
/api/webhook/Tạo bằng POST /api/webhook/.
application/jsonWebhook| Trường | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id |
integer · int32 | Không | Id. |
name |
string | Không | Tên. |
url |
string | Không | Url. |
types |
string[] | Không | Những loại. |
clientId |
integer · int64 | Không | - Đồ nhận khách hàng. |
organizationId |
integer · int64 | Không | Đơn vị tổ chức. |
curl --request POST 'https://api.selsup.ru/api/webhook/' \
--header 'Authorization: YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}'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({
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}),
});
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({
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}),
});
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={
'id': 1001,
'name': 'Example',
'url': 'https://example.com',
'types': 'string',
'clientId': 1001,
'organizationId': 1001
},
)
response.raise_for_status()
result = response.json()<?php
$payload = <<<'JSON'
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}
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(`{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}`))
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("""
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Webhook
| Trường | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id |
integer · int32 | Không | Id. |
name |
string | Không | Tên. |
url |
string | Không | Url. |
types |
string[] | Không | Những loại. |
clientId |
integer · int64 | Không | - Đồ nhận khách hàng. |
organizationId |
integer · int64 | Không | Đơn vị tổ chức. |
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
auth_requiredAuthorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
error_access_deniedCác token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
error_unknownThất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
error_empty_typeerror cụ thể cho điểm cuối. Sử dụng mã error_empty_type ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
error_empty_urlerror cụ thể cho điểm cuối. Sử dụng mã error_empty_url ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
error_invalid_urlerror cụ thể cho điểm cuối. Sử dụng mã error_invalid_url ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
error_subscription_expirederror cụ thể cho điểm cuối. Sử dụng mã error_subscription_expired ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
/api/webhook/{webhookId}Xóa bằng cách sử dụng DELETE /api/webhook/{webhookId}.
| Trường | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
webhookId |
integer · int64 | Có | - Đồ nhận dạng Webhook. |
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());
}
}Phản ứng không có cơ thể.
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
auth_requiredAuthorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
error_access_deniedCác token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
error_unknownThất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
error_subscription_expirederror cụ thể cho điểm cuối. Sử dụng mã error_subscription_expired ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.