Веб-хоктар

Қолдануға дайын жұмыс барысы

01

Webhooks- ды қолдануды бастаңыз

API токенін пайдаланып, оқу операцияларын бірінші кезекте тест деректерімен растаңыз.

Сервер жағында белгі сақтап, Authorization бағаншасына жіберіңіз.
Керек параметрлерді тексеріп, сұрау немесе жауап схемасын кеңейтіңіз.
HTTP күйін және error тұрақты өрісін қолданба қателерінде өңдеу.

GETТізім POSTЖарату DELETEЖою

Деректер моделі

Деректер құрылымы

Модельдер бір рет осы жерде тізімделеді және оларды пайдаланатын соңғы нүктелерден тікелей кеңейтілуі мүмкін.

Webhook6 өрістер

idinteger · int32

Id.

namestring

Есім.

urlstring

URL.

typesstring[]

Түрлер.

clientIdinteger · int64

Клиент танымдығы.

organizationIdinteger · int64

Ұйымның жеке куәлігі.

Қате туралы келісімшарт

Қолданба қателерін қайтару

error коды барлық жерлерде бірдей, ал пайдаланушымен бетпе-бет сөйлейтін хабарлама сервер арқылы аударылады. error-ге арналған қолданба логикасын құру және localMessage-ді көрсету үшін ғана пайдалану.

error

Интеграциялық логика үшін тұрақты машина оқуға болатын код.

localMessage

API белгі пайдаланушы тілінде көрсетілуге дайын хабарлама.

params

Сервердің жергілікті хабарлама үлгісіне интерполациялаған мәндері.

文

localMessage API белгісін иеленуші пайдаланушының lang өрісін пайдаланады. Құжаттама тілі мен Accept-Language баған оны өзгертпейді; орыс тілі пайдаланушының тілі конфигурацияланбаған кезде қолданылады.

RUПайдаланушы жері ru

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

KKҚазақша (kk)

{
  "error": "error_brand_already_exists",
  "localMessage": "Base бренді бұрыннан бар",
  "params": {
    "name": "Base"
  }
}

Аяқ нүктелері

GET

Тізім

/api/webhook/

Оқуға қол жеткізуге мүмкіндік беретін белгі

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

Жеңіспен жауап

200

Сызық элементтерінің құрылымы Webhook[]

Өріс	Түрі	Міндетті	Сипаттама
`id`	integer · int32	Жоқ	Id.
`name`	string	Жоқ	Есім.
`url`	string	Жоқ	URL.
`types`	string[]	Жоқ	Түрлер.
`clientId`	integer · int64	Жоқ	Клиент танымдығы.
`organizationId`	integer · int64	Жоқ	Ұйымның жеке куәлігі.

[
  "string"
]

Қателер4

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required

Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied

Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown

Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_subscription_expired

Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі error. Қолданба логикада error_subscription_expired тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

POST

Жарату

/api/webhook/

Жазуға қол жеткізуге мүмкіндік беретін белгі

POST /api/webhook/. арқылы құру

Өтініш органы

application/json

Нысан өрістеріWebhook

Өріс	Түрі	Міндетті	Сипаттама
`id`	integer · int32	Жоқ	Id.
`name`	string	Жоқ	Есім.
`url`	string	Жоқ	URL.
`types`	string[]	Жоқ	Түрлер.
`clientId`	integer · int64	Жоқ	Клиент танымдығы.
`organizationId`	integer · int64	Жоқ	Ұйымның жеке куәлігі.

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

Жеңіспен жауап

200

Нысан өрістері Webhook

Өріс	Түрі	Міндетті	Сипаттама
`id`	integer · int32	Жоқ	Id.
`name`	string	Жоқ	Есім.
`url`	string	Жоқ	URL.
`types`	string[]	Жоқ	Түрлер.
`clientId`	integer · int64	Жоқ	Клиент танымдығы.
`organizationId`	integer · int64	Жоқ	Ұйымның жеке куәлігі.

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

Қателер7

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required

Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied

Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown

Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_empty_type

Түрі көрсетілмеген

Аяқ нүктесі error. Қолданба логикада error_empty_type тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_empty_url

Сайт мекенжайы көрсетілмеген

Аяқ нүктесі error. Қолданба логикада error_empty_url тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_invalid_url

Сайт мекенжайы дұрыс емес, ол http:// немесе https:// басталуы керек, мекенжайда selsup, localhost сөздерін көрсетуге тыйым салынады

Аяқ нүктесі error. Қолданба логикада error_invalid_url тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_subscription_expired

Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі error. Қолданба логикада error_subscription_expired тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

DELETE

Жою

/api/webhook/{webhookId}

Жазуға қол жеткізуге мүмкіндік беретін белгі

DELETE /api/webhook/{webhookId}. арқылы өшіру

Жол параметрлері

Өріс	Түрі	Міндетті	Сипаттама
`webhookId`	integer · int64	Иә	Вебхук ID.

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

Жеңіспен жауап

200

Жауаптың денесі жоқ.

Қателер4

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required

Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied

Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown

Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_subscription_expired

Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі error. Қолданба логикада error_subscription_expired тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

Қолдануға дайын жұмыс барысы

Webhooks- ды қолдануды бастаңыз

Деректер құрылымы

Қолданба қателерін қайтару

Аяқ нүктелері

Тізім

Жеңіспен жауап

Жарату

Өтініш органы

Жеңіспен жауап

Жою

Жол параметрлері

Жеңіспен жауап

Сынақ өтiнiштерiне арналған белгі

Шын сұраныс параметрлері

Тікелей API жауап