SelSup Developers
El proyecto de ley de la Unión Europea · API Referencia
Puntos finales para Webhooks, incluyendo rutas exactas, parámetros, cuerpos de solicitud y esquemas de respuesta expandibles.
Esta página está respaldada por un contrato independiente editable. Valida las operaciones de escritura con datos de prueba antes de su uso en producción.
/api/webhook
Flujos de trabajo listos para su uso
Utilice un token API dedicado y valida primero las operaciones de lectura con los datos de prueba.
Modelo de datos
Los modelos se enumeran una vez aquí y también se pueden ampliar directamente desde los puntos finales que los utilizan.
idinteger · int32Id.
namestring- ¿Cómo se llama?
urlstring- ¿Qué quieres?
typesstring[]Los tipos.
clientIdinteger · int64Identificación del cliente.
organizationIdinteger · int64Identificación de la organización.
Contrato de error
El código error es idéntico en todas las localizaciones, mientras que el mensaje orientado al usuario es traducido por el servidor.
ExproteccionCódigo estable legible por máquina para la lógica de integración.
ExproteccionMensaje listo para la pantalla en el idioma del usuario de tokens API.
ExproteccionValores interpolados por el servidor en la plantilla de mensaje localizado.
localMessage utiliza el campo lang del usuario que posee el token API. El lenguaje de documentación y el encabezado Accept-Language no lo cambian; el ruso se utiliza cuando el usuario no tiene un idioma configurado.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "La marca Base ya existe",
"params": {
"name": "Base"
}
}Puntos finales
/api/webhook/Lista con 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[]
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
integer · int32 | No | Id. |
name |
string | No | - ¿Cómo se llama? |
url |
string | No | - ¿Qué quieres? |
types |
string[] | No | Los tipos. |
clientId |
integer · int64 | No | Identificación del cliente. |
organizationId |
integer · int64 | No | Identificación de la organización. |
[
"string"
]Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑
auth_requiredAuthorization está faltando, vacío o contiene un token inválido.
error_access_deniedEl token existe, pero su papel no puede realizar esta operación.
error_unknownFallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.
error_subscription_expirederror específico de punto final. Utilice el código estable error_subscription_expired en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.
/api/webhook/Crear con POST /api/webhook/.
application/jsonWebhook| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
integer · int32 | No | Id. |
name |
string | No | - ¿Cómo se llama? |
url |
string | No | - ¿Qué quieres? |
types |
string[] | No | Los tipos. |
clientId |
integer · int64 | No | Identificación del cliente. |
organizationId |
integer · int64 | No | Identificación de la organización. |
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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id |
integer · int32 | No | Id. |
name |
string | No | - ¿Cómo se llama? |
url |
string | No | - ¿Qué quieres? |
types |
string[] | No | Los tipos. |
clientId |
integer · int64 | No | Identificación del cliente. |
organizationId |
integer · int64 | No | Identificación de la organización. |
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑
auth_requiredAuthorization está faltando, vacío o contiene un token inválido.
error_access_deniedEl token existe, pero su papel no puede realizar esta operación.
error_unknownFallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.
error_empty_typeerror específico de punto final. Utilice el código estable error_empty_type en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.
error_empty_urlerror específico de punto final. Utilice el código estable error_empty_url en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.
error_invalid_urlerror específico de punto final. Utilice el código estable error_invalid_url en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.
error_subscription_expirederror específico de punto final. Utilice el código estable error_subscription_expired en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.
/api/webhook/{webhookId}Eliminar con DELETE /api/webhook/{webhookId}.
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
webhookId |
integer · int64 | Sí | Identificación de 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());
}
}La respuesta no tiene cuerpo.
Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑
auth_requiredAuthorization está faltando, vacío o contiene un token inválido.
error_access_deniedEl token existe, pero su papel no puede realizar esta operación.
error_unknownFallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.
error_subscription_expirederror específico de punto final. Utilice el código estable error_subscription_expired en la lógica de la aplicación; localMessage contiene la traducción mostrada anteriormente.