Веб-хоуктар

Колдонууга даяр жумуш жүрүштөрү

01

Webhooks колдонгула

API белгисин колдонуп, биринчиден тесттик маалыматтар менен окуу операцияларын тастыктаңыз.

Токенди сервер тарапка сактап, Authorization башкыга жөнөт.
Керектүү параметрлерди текшерип, суроо же жооп схемасын кеңейтүү.
HTTP абалы жана error туруктуу талаасы колдонмо каталарында иштелип чыгышы керек.

GETТизме POSTЖасагыла DELETEЖок кылуу

Маалыматтын модели

Маалыматтар структурасы

Бул жерде моделдер бир жолу көрсөтүлгөн жана аларды колдонгон акыркы пункттардан түздөн-түз кеңейтилген.

Webhook6 аймактар

idinteger · int32

Id.

namestring

Аты.

urlstring

URL.

typesstring[]

Типтер.

clientIdinteger · int64

Кардар ID.

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"
  }
}

KYКыргызча (ky)

{
  "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	Жок	Кардар ID.
`organizationId`	integer · int64	Жок	Уюмдун идентификатору.

[
  "string"
]

Каталар4

Колдонмо каталары JSON, error жана params менен JSON катары кайтарылат. error тармагы; жергиликтүү текст өзгөрүшү мүмкүн. Колдонмо каталарын кантип кайтаруу керек ↑

401auth_required

Ырасмий күбөлөндүрүү талап кылынат

Authorization жок, бош же жараксыз белгиси бар.

400error_access_denied

Кирүүгө тыюу салынган

Токен бар, бирок анын ролу бул операцияны аткара албайт.

500error_unknown

Белгисиз ката кетти. Эгерде көйгөй кайталанса, колдоо кызматына жазыңыз

Ички бузулуу. Суроо убактысын жана байланыш колдоосун үнөмдөө; мутацияны кайрадан сокурдук менен аракет кылбаңыз.

400error_subscription_expired

Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

Endpoint-specific 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	Жок	Кардар ID.
`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	Жок	Кардар ID.
`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

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

Endpoint-specific error. Колдонмо логикасында туруктуу error_empty_type кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_empty_url

Сайттын дареги көрсөтүлгөн жок

Endpoint-specific error. Колдонмо логикасында туруктуу error_empty_url кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_invalid_url

Сайттын дареги туура эмес, ал http:// же https:// менен башталышы керек, даректе selsup, localhost сөздөрүн көрсөтүүгө тыюу салынат

Endpoint-specific error. Колдонмо логикасында туруктуу error_invalid_url кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_subscription_expired

Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

Endpoint-specific 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

Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

Endpoint-specific error. Колдонмо логикасында туруктуу error_subscription_expired кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

Колдонууга даяр жумуш жүрүштөрү

Webhooks колдонгула

Маалыматтар структурасы

Колдонмо каталарын кантип кайтаруу керек

Акыркы пункттар

Тизме

Ийгиликтүү жооп

Жасагыла

Талап боюнча орган

Ийгиликтүү жооп

Жок кылуу

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

Ийгиликтүү жооп

Сынак өтүнүчтөрү үчүн белги

Чыныгы өтүнүч параметрлери

API түздөн-түз жооп