README

Wildberries REST API statistics client library with throttling requests

(russian) Русское описание ниже

A simple Wildberries REST API statistics client library with throttling requests (for example, no more than 10 requests per second according to API rules) and an example for PHP. Automatic request resending is supported when the http response code "429: too many requests" is received.

Statistics API Documentation Wildberries REST API statistics Documentation

New API Documentation Wildberries REST API Documentation

Installing

Via Composer:

composer require jumas-cola/wildberries-api-php

Usage

<?php
require 'vendor/autoload.php';

// Without Composer (and instead of "require 'vendor/autoload.php'"):
// require("your-path/wildberries-api-php/src/WbApiInterface.php");
// require("your-path/wildberries-api-php/src/WbApiClient.php");

use Leonid74\Wildberries\WbApiClient;

require_once 'vendor/autoload.php';

$token = '<you token x64>';
$dateFrom = '01-01-2022';
$dateTo = '19-01-2022';

try {
    // Create new client
    $WbApiClient = new WbApiClient( $token );

    // DEBUG level can be one of: DEBUG_NONE (default) or DEBUG_URL, DEBUG_HEADERS, DEBUG_CONTENT
    // no debug
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_NONE;
    // only URL level debug
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_URL;
    // only URL and HEADERS level debug
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_HEADERS;
    // max level of debug messages to STDOUT
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_CONTENT;
    $WbApiClient->debugLevel = WbApiClient::DEBUG_URL;

    // set the trottling of HTTP requests to 2 per second
    $WbApiClient->throttle = 2;
} catch ( Exception $e ) {
    die( "Critical exception when creating ApiClient: ({$e->getCode()}) " . $e->getMessage() );
}

/*
 * Example: Get the sales
 */
$sales = $WbApiClient->sales( $dateFrom );
if ( isset( $sales->is_error ) ) {
    echo "\nError: " . implode( '; ', $sales->errors );
} else {
    var_dump( $sales );
}

/*
 * Example: Get the report detail by period
 */
$reportDetailByPeriod = $WbApiClient->reportDetailByPeriod( $dateFrom, $dateTo );
if ( isset( $reportDetailByPeriod->is_error ) ) {
    echo "\nError: " . implode( '; ', $reportDetailByPeriod->errors );
} else {
    var_dump( $reportDetailByPeriod );
}

// You can set a common date (dateFrom) via the setDateFrom() function and then access other functions
// without passing the date
$WbApiClient->setDateFrom( $dateFrom );
$sales = $WbApiClient->sales();
$incomes = $WbApiClient->incomes();

Author

Leonid74 (https://github.com/Leonid74)

License

This software is distributed under the BSD 3-Clause license terms.

Клиентская REST API библиотека статистики Wildberries с регулированием запросов

Простая клиентская REST API библиотека статистики Wildberries с регулированием запросов (например, не более 10 запросов в секунду в соответствии с правилами API) и примером для PHP. Поддерживается автоматическая повторная отправка запроса при получении http кода ответа "429: too many requests".

Описание API статистики Wildberries REST API statistics

Описание нового API Wildberries REST API

Установка

Через Composer:

composer require jumas-cola/wildberries-api-php

Использование

<?php
require 'vendor/autoload.php';

// Без Composer можно подключить вот так (вместо "require 'vendor/autoload.php'"):
// require("your-path/wildberries-api-php/src/WbApiInterface.php");
// require("your-path/wildberries-api-php/src/WbApiClient.php");

use Leonid74\Wildberries\WbApiClient;

require_once 'vendor/autoload.php';

$token = '<Ваш токен партнера x64>';
$dateFrom = '01-01-2022';
$dateTo = '19-01-2022';

try {
    // Создаем новый клиент
    $WbApiClient = new WbApiClient( $token );

    // Уровень DEBUG может быть одним из: DEBUG_NONE (по умолчанию) или DEBUG_URL, DEBUG_HEADERS, DEBUG_CONTENT
    // без вывода отладочной информации
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_NONE;
    // выводим только URL запросов/ответов
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_URL;
    // выводим только URL и заголовки запросов/ответов
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_HEADERS;
    // выводим  URL, заголовки и всю остальную информацию запросов/ответов в STDOUT
    // $WbApiClient->debugLevel = WbApiClient::DEBUG_CONTENT;
    $WbApiClient->debugLevel = WbApiClient::DEBUG_URL;

    // Устанавливаем троттлинг в 2 запроса в секунду
    $WbApiClient->throttle = 2;
} catch ( Exception $e ) {
    die( "Критическая ошибка при создании ApiClient: ({$e->getCode()}) " . $e->getMessage() );
}

/*
 * Пример: Получаем продажи
 */
$sales = $WbApiClient->sales( $dateFrom );
if ( isset( $sales->is_error ) ) {
    echo "\nError: " . implode( '; ', $sales->errors );
} else {
    var_dump( $sales );
}

/*
 * Пример: Получаем отчет о продажах по реализации
 */
$reportDetailByPeriod = $WbApiClient->reportDetailByPeriod( $dateFrom, $dateTo );
if ( isset( $reportDetailByPeriod->is_error ) ) {
    echo "\nError: " . implode( '; ', $reportDetailByPeriod->errors );
} else {
    var_dump( $reportDetailByPeriod );
}

// Можно задать общую дату (dateFrom) через функцию setDateFrom() и затем обращаться к другим функциям,
// не передавая дату
$WbApiClient->setDateFrom( $dateFrom );
$sales = $WbApiClient->sales();
$incomes = $WbApiClient->incomes();

Автор

Leonid74 (https://github.com/Leonid74)

Лицензия

Данное ПО распространяется по лицензии BSD 3-Clause license