Internetda ishlaydigan

Ishga tayyor ish oqimlari

01

Webhooksdan foydalanish

API tokenidan foydalaning va avval o'qish operatsiyalarini sinov ma'lumotlari bilan tasdiqlash.

Tokeni server tomoniga saqlang va Authorization boshliqida yuboring.
Kerakli parametrlarni tekshiring va so'rov yoki javob sxemasini kengaytiring.
HTTP holatini va error o'rniga dastur xatolarida ishlash.

GETRo'yxat POSTyaratish DELETEOʻchirish

Ma'lumotlar modeli

Ma'lumotlar tuzilmalari

Modellari bu yerda bir marta ro'yxatga olingan va ularni ishlatadigan oxirgi nuqtalardan to'g'ridan-to'gʻri kengaytirilishi mumkin.

Webhook6 maydonlar

idinteger · int32

Id.

namestring

Ism.

urlstring

Url.

typesstring[]

Turlar.

clientIdinteger · int64

Mijozning identifikatori.

organizationIdinteger · int64

Tashkilot identifikatori.

Xato shartnomasi

Ilovalar xatolarini qaytarib berish usuli

error kodlari har bir joyda bir xil, foydalanuvchiga qaratilgan xabar server tomonidan tarjima qilinadi. error atrofida dastur mantiqasini quring va localMessage-dan faqat ko'rsatish uchun foydalaning.

error

Integratsiya mantiqasini yaratish uchun barqaror mashina o'qiladigan kod.

localMessage

API token foydalanuvchisining tilida ko'rsatishga tayyor xabar.

params

Server tomonidan mahalliylashtirilgan xabar namunalariga interpolatsiya qilingan qiymatlar.

文

localMessage API tokenini egallagan foydalanuvchining lang maydoni ishlatiladi. Hujjat tili va Accept-Language boshliq uni o'zgartirmaydi; foydalanuvchi tilni moslamasa rus tilida ishlatiladigan.

RUFoydalanuvchi manzili ru

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

UZOʻzbekcha (uz)

{
  "error": "error_brand_already_exists",
  "localMessage": "Base brendi allaqachon mavjud",
  "params": {
    "name": "Base"
  }
}

Keyingi nuqtalar

GET

Ro'yxat

/api/webhook/

Oʻqish imkoniyatiga ega token

GET /api/webhook/. qoʻllanilgan roʻyxat

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

Muvaffaqiyatli javob

200

Array elementining tuzilishi Webhook[]

Maydon	Tur	Majburiy	Tavsif
`id`	integer · int32	Yoʻq	Id.
`name`	string	Yoʻq	Ism.
`url`	string	Yoʻq	Url.
`types`	string[]	Yoʻq	Turlar.
`clientId`	integer · int64	Yoʻq	Mijozning identifikatori.
`organizationId`	integer · int64	Yoʻq	Tashkilot identifikatori.

[
  "string"
]

Xatolar4

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required

Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied

Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown

Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_subscription_expired

У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Uchrashuvda error-dan foydalanish. error_subscription_expired kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

POST

yaratish

/api/webhook/

Yozib olish imkoniyatiga ega token

POST /api/webhook/. yordamida yaratish

Talabnoma organi

application/json

Ob'ekt maydonlariWebhook

Maydon	Tur	Majburiy	Tavsif
`id`	integer · int32	Yoʻq	Id.
`name`	string	Yoʻq	Ism.
`url`	string	Yoʻq	Url.
`types`	string[]	Yoʻq	Turlar.
`clientId`	integer · int64	Yoʻq	Mijozning identifikatori.
`organizationId`	integer · int64	Yoʻq	Tashkilot identifikatori.

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

Muvaffaqiyatli javob

200

Ob'ekt maydonlari Webhook

Maydon	Tur	Majburiy	Tavsif
`id`	integer · int32	Yoʻq	Id.
`name`	string	Yoʻq	Ism.
`url`	string	Yoʻq	Url.
`types`	string[]	Yoʻq	Turlar.
`clientId`	integer · int64	Yoʻq	Mijozning identifikatori.
`organizationId`	integer · int64	Yoʻq	Tashkilot identifikatori.

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

Xatolar7

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required

Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied

Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown

Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_empty_type

Tur ko'rsatilmagan

Uchrashuvda error-dan foydalanish. error_empty_type kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_empty_url

Sayt manzili ko'rsatilmagan

Uchrashuvda error-dan foydalanish. error_empty_url kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_invalid_url

Sayt manzili noto‘g‘ri, u http:// yoki https:// bilan boshlanishi kerak, manzilda selsup, localhost so‘zlarini ko‘rsatish taqiqlangan

Uchrashuvda error-dan foydalanish. error_invalid_url kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_subscription_expired

У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Uchrashuvda error-dan foydalanish. error_subscription_expired kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

DELETE

Oʻchirish

/api/webhook/{webhookId}

Yozib olish imkoniyatiga ega token

DELETE /api/webhook/{webhookId}. yordamida oʻchirish

Yo'l parametrlari

Maydon	Tur	Majburiy	Tavsif
`webhookId`	integer · int64	Ha	Webhook 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());
    }
}

Muvaffaqiyatli javob

200

Javobning tanasi yo'q.

Xatolar4

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required

Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied

Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown

Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_subscription_expired

У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Uchrashuvda error-dan foydalanish. error_subscription_expired kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

Ishga tayyor ish oqimlari

Webhooksdan foydalanish

Ma'lumotlar tuzilmalari

Ilovalar xatolarini qaytarib berish usuli

Keyingi nuqtalar

Ro'yxat

Muvaffaqiyatli javob

yaratish

Talabnoma organi

Muvaffaqiyatli javob

Oʻchirish

Yo'l parametrlari

Muvaffaqiyatli javob

Sinov talablari uchun belgisi

Haqiqiy talab parametrlari

API- ning jonli javoblari