Webhooks

Gotowe do użytkowania przepływy robocze

01

Zacznij używać Webhooks

Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.

Trzymaj token z serwera i wysłać go w nagłówku Authorization.
Sprawdź wymagane parametry i poszerz schemat żądania lub odpowiedzi.
Zrób z statusem HTTP i stabilnym pole error w przypadku błędów aplikacyjnych.

GETLista POSTStwórz DELETEUsuń

Model danych

Struktura danych

Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.

Webhook6 pola

idinteger · int32

Id.

namestring

- Nazwa.

urlstring

- Url.

typesstring[]

Typy.

clientIdinteger · int64

Id klientów.

organizationIdinteger · int64

Id organizacyjny.

Umowa o błędzie

W jaki sposób można zwrócić błędy w aplikacji

Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.

error

Stabilny kod czytelny maszynowo do logiki integracyjnej.

localMessage

Przesłanie gotowe do wyświetlania w języku użytkownika tokenu API.

params

Wartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.

文

localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.

RULokalizacja użytkownika jest ru

{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}

PLPolski (pl)

{
  "error": "error_brand_already_exists",
  "localMessage": "Marka Base już istnieje",
  "params": {
    "name": "Base"
  }
}

Punkty końcowe

GET

Lista

/api/webhook/

Token z dostępem do odczytu

Lista używająca 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());
    }
}

Odpowiedź udana

200

Struktura pozycji zestawu Webhook[]

Pole	Typ	Wymagane	Opis
`id`	integer · int32	Nie	Id.
`name`	string	Nie	- Nazwa.
`url`	string	Nie	- Url.
`types`	string[]	Nie	Typy.
`clientId`	integer · int64	Nie	Id klientów.
`organizationId`	integer · int64	Nie	Id organizacyjny.

[
  "string"
]

Władze4

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required

Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied

Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown

Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_subscription_expired

Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

POST

Stwórz

/api/webhook/

Token z dostępem do pisania

Tworzyć za pomocą POST /api/webhook/.

Organ wnioskujący

application/json

Połączenia obiektuWebhook

Pole	Typ	Wymagane	Opis
`id`	integer · int32	Nie	Id.
`name`	string	Nie	- Nazwa.
`url`	string	Nie	- Url.
`types`	string[]	Nie	Typy.
`clientId`	integer · int64	Nie	Id klientów.
`organizationId`	integer · int64	Nie	Id organizacyjny.

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());
    }
}

Odpowiedź udana

200

Połączenia obiektu Webhook

Pole	Typ	Wymagane	Opis
`id`	integer · int32	Nie	Id.
`name`	string	Nie	- Nazwa.
`url`	string	Nie	- Url.
`types`	string[]	Nie	Typy.
`clientId`	integer · int64	Nie	Id klientów.
`organizationId`	integer · int64	Nie	Id organizacyjny.

{
  "id": 1001,
  "name": "Example",
  "url": "https://example.com",
  "types": "string",
  "clientId": 1001,
  "organizationId": 1001
}

Władze7

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required

Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied

Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown

Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_empty_type

Nie określono typu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_type; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_url

Nie podano adresu strony internetowej

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_url; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_invalid_url

Nieprawidłowy adres strony, musi zaczynać się od http:// lub https://, w adresie zabronione jest podawanie słów selsup, localhost

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_invalid_url; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired

Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

DELETE

Usuń

/api/webhook/{webhookId}

Token z dostępem do pisania

Usuwanie za pomocą DELETE /api/webhook/{webhookId}.

Parametry ścieżki

Pole	Typ	Wymagane	Opis
`webhookId`	integer · int64	Tak	Id Webhooka.

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());
    }
}

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze4

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required

Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied

Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown

Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_subscription_expired

Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

Gotowe do użytkowania przepływy robocze

Zacznij używać Webhooks

Struktura danych

W jaki sposób można zwrócić błędy w aplikacji

Punkty końcowe

Lista

Odpowiedź udana

Stwórz

Organ wnioskujący

Odpowiedź udana

Usuń

Parametry ścieżki

Odpowiedź udana

Token do wniosków o badania

Prawdziwe parametry żądania

Odpowiedź API