SelSup Developers
Le public API · API Référence
Les points d'extrémité pour les Webhooks, y compris les itinéraires exacts, les paramètres, les corps de requête et les schémas de réponse extensibles.
Cette page est soutenue par un contrat indépendant éditable. Valider les opérations de rédaction avec des données de test avant utilisation de production.
/api/webhook
Flux de travail prêts à l'emploi
Utilisez un jeton API dédié et validez d'abord les opérations de lecture avec les données de test.
Modèle de données
Les modèles sont énumérés une fois ici et peuvent également être étendus directement depuis les terminaux qui les utilisent.
idinteger · int32Id.
namestringNom.
urlstring- Je vous en prie.
typesstring[]Des types.
clientIdinteger · int64Nom du client.
organizationIdinteger · int64Identification de l'organisation.
Contrats d'erreur
Le code error est identique dans chaque locale, tandis que le message d'utilisateur est traduit par le serveur.
Le projet de loiCode stable lisible par machine pour la logique d'intégration.
Le projet de loiMessage prêt à être affiché dans la langue de l'utilisateur de jeton API.
Le projet de loiLes valeurs interpolées par le serveur dans le modèle de message localisé.
localMessage utilise le champ lang de l'utilisateur qui possède le jeton API. Le langage de documentation et l'en-tête Accept-Language ne le modifient pas; le russe est utilisé lorsque l'usager n'a pas de langue configurée.
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}{
"error": "error_brand_already_exists",
"localMessage": "La marque Base existe déjà",
"params": {
"name": "Base"
}
}Les points de fin
/api/webhook/Liste utilisant 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[]
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
integer · int32 | Non | Id. |
name |
string | Non | Nom. |
url |
string | Non | - Je vous en prie. |
types |
string[] | Non | Des types. |
clientId |
integer · int64 | Non | Nom du client. |
organizationId |
integer · int64 | Non | Identification de l'organisation. |
[
"string"
]Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
auth_requiredAuthorization est manquant, vide ou contient un jeton non valide.
error_access_deniedLe jeton existe, mais son rôle ne peut pas effectuer cette opération.
error_unknownFaillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
error_subscription_expirederror spécifique au point final. Utilisez le code error_subscription_expired stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
/api/webhook/Créer à l'aide de POST /api/webhook/.
application/jsonWebhook| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
integer · int32 | Non | Id. |
name |
string | Non | Nom. |
url |
string | Non | - Je vous en prie. |
types |
string[] | Non | Des types. |
clientId |
integer · int64 | Non | Nom du client. |
organizationId |
integer · int64 | Non | Identification de l'organisation. |
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
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
id |
integer · int32 | Non | Id. |
name |
string | Non | Nom. |
url |
string | Non | - Je vous en prie. |
types |
string[] | Non | Des types. |
clientId |
integer · int64 | Non | Nom du client. |
organizationId |
integer · int64 | Non | Identification de l'organisation. |
{
"id": 1001,
"name": "Example",
"url": "https://example.com",
"types": "string",
"clientId": 1001,
"organizationId": 1001
}Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
auth_requiredAuthorization est manquant, vide ou contient un jeton non valide.
error_access_deniedLe jeton existe, mais son rôle ne peut pas effectuer cette opération.
error_unknownFaillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
error_empty_typeerror spécifique au point final. Utilisez le code error_empty_type stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
error_empty_urlerror spécifique au point final. Utilisez le code error_empty_url stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
error_invalid_urlerror spécifique au point final. Utilisez le code error_invalid_url stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
error_subscription_expirederror spécifique au point final. Utilisez le code error_subscription_expired stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
/api/webhook/{webhookId}Supprimer en utilisant DELETE /api/webhook/{webhookId}.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
webhookId |
integer · int64 | Oui | Le numéro 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 réponse n'a pas de corps.
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
auth_requiredAuthorization est manquant, vide ou contient un jeton non valide.
error_access_deniedLe jeton existe, mais son rôle ne peut pas effectuer cette opération.
error_unknownFaillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
error_subscription_expirederror spécifique au point final. Utilisez le code error_subscription_expired stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.