Квитанция

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

01

Кредиттин эсебин колдонууну баштаңыз

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

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

GETТөлөмдөрдү алуу POSTТоктом үчүн квитанция түзүү GETКвитанция алыңыз

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

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

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

Receipt14 аймактар

idinteger · int64

Id.

read-only

clientIdinteger · int64

Кардар ID.

read-only

orderIdinteger · int64

Түзөтүү ID.

read-only

organizationIdinteger · int64

Уюмдун идентификатору.

read-only

externalReceiptIdstring

Тышкы квитанциянын идентификатору.

fiscalNumberstring

Салыктык сан.

cashRegisterServicestring

Акча кагаз каттоо кызматы.

fnsUrlstring

Фнс УРЛ.

statusstring

Status.

receiptTypestring

Квитанциянын түрү.

totalAmountnumber · double

Жалпы сумма.

createdDatestring · date-time

Жараткандын күнү.

read-only

completedDatestring · date-time

Толук дата.

errorMessagestring

Каталуу билдирүүсү.

Келишимдин катасы

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

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/receipt/order/{orderId}

Окуу мүмкүнчүлүгү бар белги

GET /api/receipt/order/{orderId}. аркылуу буйрук боюнча квитанциялар алуу

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

Талаа	Түрү	Милдеттүү	Сүрөттөмө
`orderId`	integer · int64	Ооба	Түзөтүү ID.

curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  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/receipt/order/1001', {
  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/receipt/order/1001',
    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/receipt/order/1001',
    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/receipt/order/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/receipt/order/1001"))
            .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

Топтун элементтеринин түзүлүшү Receipt[]

Талаа	Түрү	Милдеттүү	Сүрөттөмө
`id`	integer · int64	Жок	Id.
`clientId`	integer · int64	Жок	Кардар ID.
`orderId`	integer · int64	Жок	Түзөтүү ID.
`organizationId`	integer · int64	Жок	Уюмдун идентификатору.
`externalReceiptId`	string	Жок	Тышкы квитанциянын идентификатору.
`fiscalNumber`	string	Жок	Салыктык сан.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Жок	Акча кагаз каттоо кызматы.
`fnsUrl`	string	Жок	Фнс УРЛ.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Жок	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Жок	Квитанциянын түрү.
`totalAmount`	number · double	Жок	Жалпы сумма.
`createdDate`	string · date-time	Жок	Жараткандын күнү.
`completedDate`	string · date-time	Жок	Толук дата.
`errorMessage`	string	Жок	Каталуу билдирүүсү.

[
  "string"
]

Каталар3

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

401auth_required

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

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

400error_access_denied

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

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

500error_unknown

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

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

POST

Токтом үчүн квитанция түзүү

/api/receipt/order/{orderId}

Жазуу мүмкүнчүлүгү бар белги

POST /api/receipt/order/{orderId}. аркылуу буйрутма үчүн квитанция түзүү

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

Талаа	Түрү	Милдеттүү	Сүрөттөмө
`orderId`	integer · int64	Ооба	Түзөтүү ID.

Сурамжылоо параметрлери

Талаа	Түрү	Милдеттүү	Сүрөттөмө
`type`Демейки маани: INCOME	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Жок	Type.

curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  method: 'POST',
  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/receipt/order/1001', {
  method: 'POST',
  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.post(
    'https://api.selsup.ru/api/receipt/order/1001',
    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/receipt/order/1001',
    CURLOPT_CUSTOMREQUEST => 'POST',
    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("POST", "https://api.selsup.ru/api/receipt/order/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/receipt/order/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("POST", 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

Объекттердин талаалары Receipt

Талаа	Түрү	Милдеттүү	Сүрөттөмө
`id`	integer · int64	Жок	Id.
`clientId`	integer · int64	Жок	Кардар ID.
`orderId`	integer · int64	Жок	Түзөтүү ID.
`organizationId`	integer · int64	Жок	Уюмдун идентификатору.
`externalReceiptId`	string	Жок	Тышкы квитанциянын идентификатору.
`fiscalNumber`	string	Жок	Салыктык сан.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Жок	Акча кагаз каттоо кызматы.
`fnsUrl`	string	Жок	Фнс УРЛ.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Жок	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Жок	Квитанциянын түрү.
`totalAmount`	number · double	Жок	Жалпы сумма.
`createdDate`	string · date-time	Жок	Жараткандын күнү.
`completedDate`	string · date-time	Жок	Толук дата.
`errorMessage`	string	Жок	Каталуу билдирүүсү.

{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}

Каталар3

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

401auth_required

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

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

400error_access_denied

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

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

500error_unknown

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

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

GET