Документация API SafeCheck

API SafeCheck предоставляет разработчикам возможность проверять подлинность чеков с помощью простых и эффективных методов. Используя это API, вы можете интегрировать функции проверки чеков в свои приложения, обеспечивая безопасность и надежность для пользователей.

Техническая информация об API

Основной эндпоинт:

https://api-safecheck.ru/

Rate Limit:

Количество запросов: 10 запросов в секунду

1. Получить информацию о пользователе

Метод: GET

URL: /getAccountInfo

Заголовки:

SF-USER-ID: <user_id #Необязателен, если есть резрешение>
SF-API-KEY: <api_key>

Ответ:

{
    "error": 0,
    "msg": "",
    "result": {
        "user_id #Необязателен, если есть резрешение": 123,
        "status": "1",
        "checks_balance": 10,
        "usdt_balance": 100.0,
        "username": "example_user",
        "total_checks_cnt": 5,
        "fake_checks_cnt": 2,
        "original_checks_cnt": 3
    }
}

Пример на Python:

import requests

url = "https://api-safecheck.ru/getAccountInfo"
headers = {
    "SF-USER-ID": <user_id #Необязателен, если есть резрешение>,
    "SF-API-KEY": <api_key>
}

response = requests.get(url, headers=headers)
print(response.json())

2. Получить все чеки

Метод: GET

URL: /getAllChecks

Заголовки:

SF-USER-ID: <user_id #Необязателен, если есть резрешение>
SF-API-KEY: <api_key>

Ответ:

{
    "error": 0,
    "msg": "",
    "result": [
        {
            "file_id": "uuid-1",
            "result": "{\"is_original\": true, ...}",
            "status": "completed"
        },
        ...
    ]
}

Пример на Python:

import requests

url = "https://api-safecheck.ru/getAllChecks"
headers = {
    "SF-USER-ID": <user_id #Необязателен, если есть резрешение>,
    "SF-API-KEY": <api_key>
}

response = requests.get(url, headers=headers)
print(response.json())

3. Получить чек по ID

Метод: GET или POST

URL: /getCheck

GET Запрос:

Параметры:

file_id: <file_id> (обязательный)

Заголовки:

SF-USER-ID: <user_id #Необязателен, если есть резрешение>
SF-API-KEY: <api_key>

POST Запрос:

Тело запроса:

{
    "file_id": <file_id>
}

Ответ:

{
    "error": 0,
    "msg": "",
    "result": {
	"color": "white", #May be white/yellow/red/black/None (none if struct_passed is False). Missing if an error occurred.
        "data": {
            "amount": "5 600,00 ₽",
            "bank_name": "Тинькофф",
            "recipient_fio": "Александр Петрович С.",
            "recipient_req": "**** 1234"
	    "status": "Успешно"
        },
        "file_id": "94f3bfb5-6130-40ae-9ccd-cf3e927bb6a0",
	"is_original": true,
        "recommendation": Ok, #May be Ok/Fake/Warning. Missing if an error occurred.
        "struct_result": "15/15",
        "struct_passed": true,
        "verifer": "tinkoff_default",
	"device_error": false #Occurs if the file was saved incorrectly.
    }
}

Пример на Python (GET):

import requests

url = "https://api-safecheck.ru/getCheck?file_id=<file_id>"
headers = {
    "SF-USER-ID": <user_id #Необязателен, если есть резрешение>,
    "SF-API-KEY": <api_key>
}

response = requests.get(url, headers=headers)
print(response.json())

Пример на Python (POST):

import requests

url = "https://api-safecheck.ru/getCheck"
headers = {
    "SF-USER-ID": <user_id #Необязателен, если есть резрешение>,
    "SF-API-KEY": <api_key>
}
data = {
    "file_id": <file_id>
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

4. Проверить чек

Метод: POST

URL: /check

Заголовки:

SF-USER-ID: <user_id #Необязателен, если есть резрешение>
SF-API-KEY: <api_key>

Форма данных:

file: <файл.pdf> (обязательный)

Ответ:

{
    "error": 0,
    "msg": "",
    "result": {
        "status": "checking",
        "file_id": "uuid-1"
    }
}

Пример на Python:

import requests

url = "https://api-safecheck.ru/check"
headers = {
    "SF-USER-ID": <user_id #Необязателен, если есть резрешение>,
    "SF-API-KEY": <api_key>
}
files = {
    'file': open('<файл.pdf>', 'rb')
}

response = requests.post(url, headers=headers, files=files)
print(response.json())

Описание ошибок

Коды ошибок:

"Unauthorized" - Неверный API ключ или ID пользователя
"No file provided" - Нет файла в запросе
"You have not agreed to the terms of the user" - Пользователь не согласился с условиями использования
"Insufficient balance" - Недостаточно средств на счете для проверки
"Internal Server Error" - Внутренняя ошибка сервера
"Check not found" - Чек не найден по указанному file_id
"file_id is required" - Обязательный параметр file_id отсутствует
"Only PDF files are allowed" - Допустимый формат файла - PDF
"Cant parse data" - Ошибка при парсинге данных

Пример ответа с ошибкой:

{
    "error": 1,
    "msg": "Unauthorized",
    "result": null
}