Статистика

Чтобы получить статистику вашего аккаунта, отправьте POST запрос на следующий URL:

Статистика платежей за период

POST https://api.cryptocloud.plus/v2/invoice/merchant/statistics

Отправив этот запрос, вы получите статистику по счетам за указанный период.

Request Body

Name	Type	Description
start*	String	Дата в формате "dd.mm.yyyy"
end*	String	Дата в формате "dd.mm.yyyy"

200: OK Успешный ответ

{
    "status": "success",
    "result": {
        "count": {
            "all": 59,
            "created": 41,
            "paid": 16,
            "overpaid": 1,
            "partial": 1,
            "canceled": 0
        },
        "amount": {
            "all": 4683.83,
            "created": 3032.63,
            "paid": 1531.0,
            "overpaid": 100.2,
            "partial": 20.0,
            "canceled": 0
        }
    }
}

Описание параметров ответа

На успешный запрос приходит ответ со статусом success и объектом result.

• count — объект, в котором находятся значения по количеству счетов.

• amount — объект, в котором находятся значения по суммам в USD.

• all — все счета.

• created — счета со статусом «Создан».

• paid — счета со статусом «Оплачен».

• overpaid — счета со статусом «Переплата».

• partial — счета со статусом «Частично оплачен».

• canceled — счета со статусом «Отменен».

Примеры запросов

Эти примеры показывают, как можно отправить запрос для получения статистики. Обратите внимание, что необходимо предоставить ваш API ключ в заголовке Authorization для успешной авторизации запроса.

cURL

curl -X POST https://api.cryptocloud.plus/v2/invoice/merchant/statistics \
     -H "Authorization: Token <API KEY>" \
     -H "Content-Type: application/json" \
     -d '{"start":"01.01.2023","end":"31.01.2023"}'

Python

import requests

url = "https://api.cryptocloud.plus/v2/invoice/merchant/statistics"
headers = {
    "Authorization": "Token <API KEY>"
}
data = {
    "start": "01.01.2023",
    "end": "31.01.2023"
}

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

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Fail:", response.status_code, response.text)

JavaScript

fetch('https://api.cryptocloud.plus/v2/invoice/merchant/statistics', {
    method: 'POST',
    headers: {
        'Authorization': 'Token <API KEY>',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        start: '01.01.2023',
        end: '31.01.2023'
    })
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Fail: ' + response.status + ' ' + response.statusText);
    }
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.cryptocloud.plus/v2/invoice/merchant/statistics");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    "start" => "01.01.2023",
    "end" => "31.01.2023"
)));

$headers = array(
    "Authorization: Token <API KEY>",
    "Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    $statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($statusCode == 200) {
        echo "Success: " . $response;
    } else {
        echo "Fail: " . $statusCode . " " . $response;
    }
}

curl_close($ch);
?>

Мы регулярно работаем над улучшением документации сервиса для разработчиков. Пожалуйста, оцените качество и полезность материалов по ссылке.