Webhooks

Kullanılabilir iş akışları

01

Webhooks kullanmaya başlayın

Özel bir API token kullanın ve önce test verileri ile okuma işlemlerini doğrulayın.

Token sunucu tarafında tut ve Authorization başlığı gönder.
Gerekli parametreleri kontrol edin ve istek veya yanıt şeması genişletin.
Uygulama hatalarında HTTP durumunu ve sabit error alanını ele alın.

GETListe POSTYaratmak DELETESil

Verim modeli

Veriler yapısı

Modeller burada bir kez listelenmiştir ve bunları kullanan uç noktalardan doğrudan genişletilebilir.

Webhook6 alanlar

idinteger · int32

Id.

namestring

Adı.

urlstring

- Urt.

typesstring[]

Tipler.

clientIdinteger · int64

Müşteri kimliği.

organizationIdinteger · int64

Teşkilat Kimliği.

Hata sözleşmesi

Uygulama hataları nasıl iade edilir

error kodu her yerde aynıdır, kullanıcıya yönelik mesaj ise sunucu tarafından tercüme edilir. error etrafında uygulama mantığı oluşturun ve localMessage'i yalnızca görüntülemek için kullanın.

error

Entegre mantığı için sabit makine okunur kod.

localMessage

API token kullanıcısının dilinde görüntülemeye hazır mesaj.

params

Sunucu tarafından yerel mesaj şablonuna girilen değerler.

文

localMessage, API tokenine sahip olan kullanıcının lang alanını kullanır. Belgeleme dili ve Accept-Language başlığı değiştirmez; kullanıcıya dil yapılandırılmadığında Rusça kullanılır.

RUKullanıcı yerel ru

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

TRTürkçe (tr)

{
  "error": "error_brand_already_exists",
  "localMessage": "Base markası zaten mevcut",
  "params": {
    "name": "Base"
  }
}

Son noktaları

GET

Liste

/api/webhook/

Okuma erişimi olan işaret

GET /api/webhook/. kullanan liste

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

Başarılı tepki

200

Array öğesi yapısı Webhook[]

Alan	Tür	Zorunlu	Açıklama
`id`	integer · int32	Hayır	Id.
`name`	string	Hayır	Adı.
`url`	string	Hayır	- Urt.
`types`	string[]	Hayır	Tipler.
`clientId`	integer · int64	Hayır	Müşteri kimliği.
`organizationId`	integer · int64	Hayır	Teşkilat Kimliği.

[
  "string"
]

Hatalar4

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required

Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied

Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown

Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

400error_subscription_expired

Tarife süreniz doldu. Hizmeti kullanmaya devam etmek için tarifeyi ödeyin.

Uygulama mantığında sabit error_subscription_expired kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

POST

Yaratmak

/api/webhook/

Yazma erişimli işaretleme

POST /api/webhook/. kullanarak oluştur

İstekçi organ

application/json

Nesne alanlarıWebhook

Alan	Tür	Zorunlu	Açıklama
`id`	integer · int32	Hayır	Id.
`name`	string	Hayır	Adı.
`url`	string	Hayır	- Urt.
`types`	string[]	Hayır	Tipler.
`clientId`	integer · int64	Hayır	Müşteri kimliği.
`organizationId`	integer · int64	Hayır	Teşkilat Kimliği.

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

Başarılı tepki

200

Nesne alanları Webhook

Alan	Tür	Zorunlu	Açıklama
`id`	integer · int32	Hayır	Id.
`name`	string	Hayır	Adı.
`url`	string	Hayır	- Urt.
`types`	string[]	Hayır	Tipler.
`clientId`	integer · int64	Hayır	Müşteri kimliği.
`organizationId`	integer · int64	Hayır	Teşkilat Kimliği.

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

Hatalar7

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required

Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied

Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown

Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

400error_empty_type

Tip belirtilmemiş

Uygulama mantığında sabit error_empty_type kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_empty_url

Site adresi belirtilmemiş

Uygulama mantığında sabit error_empty_url kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_invalid_url

Geçersiz site adresi, http:// veya https:// ile başlamalı, adreste selsup, localhost kelimeleri belirtmek yasaktır

Uygulama mantığında sabit error_invalid_url kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_subscription_expired

Tarife süreniz doldu. Hizmeti kullanmaya devam etmek için tarifeyi ödeyin.

Uygulama mantığında sabit error_subscription_expired kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

DELETE

Sil

/api/webhook/{webhookId}

Yazma erişimli işaretleme

DELETE /api/webhook/{webhookId}. kullanarak sil

Yol parametreleri

Alan	Tür	Zorunlu	Açıklama
`webhookId`	integer · int64	Evet	Webhook Kimliği.

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

Başarılı tepki

200

Cevapın bir vücudu yok.

Hatalar4

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required

Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied

Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown

Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

400error_subscription_expired

Tarife süreniz doldu. Hizmeti kullanmaya devam etmek için tarifeyi ödeyin.

Uygulama mantığında sabit error_subscription_expired kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

Kullanılabilir iş akışları

Webhooks kullanmaya başlayın

Veriler yapısı

Uygulama hataları nasıl iade edilir

Son noktaları

Liste

Başarılı tepki

Yaratmak

İstekçi organ

Başarılı tepki

Sil

Yol parametreleri

Başarılı tepki

Test istekleri için işaret

Gerçek talep parametreleri

Canlı API tepkisi