网络 · SelSup Developers

准备使用的工作流程

01

开始使用Webhooks

使用专用API代币,首先验证测试数据的读取操作.

保存代币服务器侧,然后将其发送到Authorization标题中.
检查所需参数,并扩大请求或响应方案.
在应用错误中处理HTTP状态和稳定的error字段.

GET列表 POST创建 DELETE删除

数据模型

数据结构

模型在此列出一次,并且可以直接从使用它们的终端点扩展.

Webhook6 字段

idinteger · int32

Id.

namestring

姓名.

urlstring

查看一个URL.

typesstring[]

类型.

clientIdinteger · int64

客户身份证.

organizationIdinteger · int64

组织身份证.

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在error周围的应用逻辑,仅用于显示.

鱼类

稳定机器可读的代码用于集成逻辑.

鱼类

在API代币用户语言中显示准备的消息.

鱼类

服务器在本地化消息模板中插入的值.

文

localMessage使用了 API代币的用户的lang字段.文档语言和 Accept-Language标题不会改变它;当用户没有语言配置时,使用俄语.

RU用户位置是 ru

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

CN中文 (cn)

{
  "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,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required

需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied

拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown

发生了一个未知的错误。如果该问题再次发生，请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_subscription_expired

你的费率已经过期。支付关税以继续使用该服务。

应用逻辑中使用稳定的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,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required

需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied

拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown

发生了一个未知的错误。如果该问题再次发生，请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_empty_type

未指定类型

应用逻辑中使用稳定的error_empty_type代码;localMessage包含上述翻译.

400error_empty_url

未指定网站地址

应用逻辑中使用稳定的error_empty_url代码;localMessage包含上述翻译.

400error_invalid_url

网站地址不正确，应该以http:// 或 https:// 开始，地址中不允许有selsup、localhost。

应用逻辑中使用稳定的error_invalid_url代码;localMessage包含上述翻译.

400error_subscription_expired

你的费率已经过期。支付关税以继续使用该服务。

应用逻辑中使用稳定的error_subscription_expired代码;localMessage包含上述翻译.

DELETE

删除

/api/webhook/{webhookId}

具有写入的标志

使用 DELETE /api/webhook/{webhookId}.删除

路径参数

字段	类型	必填	描述
`webhookId`	integer · int64	是	网页身份证.

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,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required

需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied

拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown

发生了一个未知的错误。如果该问题再次发生，请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_subscription_expired

你的费率已经过期。支付关税以继续使用该服务。

应用逻辑中使用稳定的error_subscription_expired代码;localMessage包含上述翻译.

网络

准备使用的工作流程

开始使用Webhooks

数据结构

如何返回应用错误

终点

列表

成功的反应

创建

要求机构

成功的反应

删除

路径参数

成功的反应

测试请求的标志

实际请求参数

现场API响应