PHPackages                             pllano/api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. pllano/api

ActiveLibrary[API Development](/categories/api)

pllano/api
==========

PLLANO REST API PHP

1.0.3(8y ago)013MITPHPPHP >=5.3.0

Since Nov 10Pushed 8y ago1 watchersCompare

[ Source](https://github.com/pllano/api)[ Packagist](https://packagist.org/packages/pllano/api)[ Docs](https://github.com/pllano/api)[ RSS](/packages/pllano-api/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

PLLANO API
==========

[](#pllano-api)

Документация по работе с PLLANO API

PLLANO RESTful API — это бесплатный инструментарий для интеграции [pllano.com](https://pllano.com/) в ваш продукт.

Вы можете ипользовать наш [PLLANO PHP HTTP client](src/Api.php) или популярный PHP HTTP client [Guzzle](https://github.com/guzzle/guzzle) - [Документация](http://docs.guzzlephp.org/en/stable/)

PLLANO API работает согластно стантарту [APIS-2018](https://github.com/pllano/APIS-2018)
----------------------------------------------------------------------------------------

[](#pllano-api-работает-согластно-стантарту-apis-2018)

#### Используйте документацию [APIS-2018](https://github.com/pllano/APIS-2018)

[](#используйте-документацию-apis-2018)

#### Список всех ресурсов PLLANO API соответствует списку ресурсов [APIS-2018](https://github.com/pllano/APIS-2018)

[](#список-всех-ресурсов-pllano-api-соответствует-списку-ресурсов-apis-2018)

Новый адрес сервера API - [api.pllano.com](https://api.pllano.com)
------------------------------------------------------------------

[](#новый-адрес-сервера-api---apipllanocom)

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

### Ресурсы PLLANO RESTful API

[](#ресурсы-pllano-restful-api)

Сейчас доступны следующие ресурсы:

- [/site](https://api.pllano.com/site) - `GET` - Конфигурация сайта (Требует public\_key)
- [/price](https://api.pllano.com/price) - `GET` - Товары и цены (Требует public\_key)
- [/order](https://api.pllano.com/order) - `GET` `POST` `PUT` - Заказы (Требует public\_key)
- [/install](https://api.pllano.com/install) - `POST` `PUT` - Установка сайта (Работает без public\_key)
- [/language](https://api.pllano.com/language) - `GET` - Локализация (Работает без public\_key)
- [/stores\_list](https://api.pllano.com/stores_list) - `GET` - Список типов магазинов (Работает без public\_key)
- [/templates\_list](https://api.pllano.com/templates_list) - `GET` - Список шаблонов (Работает без public\_key)
- [/test](https://api.pllano.com/test) - `GET` `POST` `PUT` `PATCH` `DELETE` - Тесты (Работает без public\_key)

[Список всех запланированных ресурсов PLLANO API](https://github.com/pllano/APIS-2018)

### PLLANO API потдерживает запросы:

[](#pllano-api-потдерживает-запросы)

- `POST /price` Создание записи
- `POST /price/42` Ошибка
- `GET /price` Список прайс-строк
- `GET /price/42` Данные конкретной прайс-строки
- `PUT /price` Обновить данные прайс-строк
- `PUT /price/42` Обновить данные конкретной прайс-строки
- `DELETE /price` Удалить все прайс-строки
- `DELETE /price/42` Удалить конкретную прайс-строку

### URL PLLANO API

[](#url-pllano-api)

- `https://api.pllano.com/{resource}/{uid}`
- `{resource}` - ресурс к которому обращаемся. Например `price` или `search`
- `{id}` - уникальный индефикатор

### GET запрос к API

[](#get-запрос-к-api)

- `?public_key={public_key}&order={order}&sort={sort}&offset={offset}&limit={limit}`
- `{public_key}` - Ваш ключ к API
- `{limit}` - Записей на страницу. По умолчанию 10
- `{offset}` - Страница. По умолчанию 0
- `{order}` - Тип сортировки. По умолчанию ASC
- `{sort}` - Поле сортировки. По умолчанию id

### API - Всегда возвращает код 200 даже при логических ошибках !

[](#api---всегда-возвращает-код-200-даже-при-логических-ошибках-)

`HTTP/1.1 200 OK`

`Content-Type: application/json`

### В теле ответа API вернет состояния HTTP или код ошибки.

[](#в-теле-ответа-api-вернет-состояния-http-или-код-ошибки)

[Коды состояния HTTP](https://github.com/pllano/APIS-2018/tree/master/http-codes)

### Демо

[](#демо)

Перейдите по ссылке [https://api.pllano.com/price?public\_key=test&order=asc&sort=uid&offset=0&limit=10](https://api.pllano.com/price?public_key=test&order=asc&sort=uid&offset=0&limit=10)

[PLLANO PHP HTTP client](src/Api.php)
-------------------------------------

[](#pllano-php-http-client)

### Легкий старт

[](#легкий-старт)

Скачайте файлы [test.php](test.php) и [src/Api.php](src/Api.php) положите их в корень вашего сайта.

Запуск: `http://example.com/test.php`

PLLANO REST API PHP обратится по адресу:

[https://api.pllano.com/price?public\_key=test&order=asc&sort=uid&offset=0&limit=10](https://api.pllano.com/price?public_key=test&order=asc&sort=uid&offset=0&limit=10)

В ответ получит массив json конвертирует его в массив PHP

Установка PLLANO PHP HTTP client с помощью Composer
---------------------------------------------------

[](#установка-pllano-php-http-client-с-помощью-composer)

### Требования

[](#требования)

PHP >= 5.3\*

```
$ composer require pllano/api

```

composer.json

```
"require": {
	"pllano/api": "1.0.3"
}
```

### Пример использования PLLANO PHP HTTP client

[](#пример-использования-pllano-php-http-client)

```
require '../vendor/autoload.php'; // Подключить Composer
// require_once __DIR__.'/Api.php';

$action = 'price'; // Название модели к которой мы обращаемся
$metod = 'curl'; // get = file_get_contents или curl
$id = null; // Уникальный индефикатор item. Если null выводим список.

$public_key = 'test'; // Публичный ключ авторизации. По умолчанию test для настройки API
$query = null; // Дублируем тип запроса. Имеет приоритет выше чем в самом запросе.
$order = null; // Сотрировка asc|desc По умолчанию asc
$sort = null; // Поле по которому сортируем. По умолчанию id
$offset = null; // Смещение. Начать с указанной страницы. По умолчанию 0
$limit = null; // Лимит вывода записей на страницу. По умолчанию 10

//Массив для GET запроса
$getArray = array(
	"public_key"	=> $public_key,
	"query"		=> $query,
	"order"		=> $order,
	"sort"		=> $sort,
	"offset"	=> $offset,
	"limit"		=> $limit
);

$api = new Pllano\Api('ua');
$records = $api->get($getArray, $action, $metod, $id);

if (isset($records['header']['code'])) {
if ($records['header']['code'] == '200') {
	$count = count($records['price']['items']);
	if ($count >= 1) {
		foreach($records['price']['items'] as $item)
		{
			print_r($item['item']['id']);
		}
	}
}
}
```

### Пример использования Guzzle

[](#пример-использования-guzzle)

```
$ composer require guzzlehttp/guzzle

```

composer.json

```
"require": {
	"guzzlehttp/guzzle": "^6.3"
}
```

```
require '../vendor/autoload.php'; // Подключить Composer
use GuzzleHttp\Client as Guzzle;
// Подключаем Guzzle
$client = new Guzzle();
// Отправляем запрос
$response = $client->request('GET', 'https://ua.pllano.com/api/v1/json/price/?public_key=test');
// Получаем тело ответа
$output = $response->getBody();
$records = json_encode(json_decode($output, true), JSON_PRETTY_PRINT);
// Вывести на экран json
print_r($records);
```

### Структура ответа API в json формате

[](#структура-ответа-api-в-json-формате)

```
{
    "headers": {
        "status": "200 OK",
        "code": "200",
        "message": "OK",
	"message_id": "https:\/\/github.com\/pllano\/APIS-2018\/tree\/master\/http-codes\/200.md"
    },
    "response": {
        "api": "v1.0",
        "auth": "QueryKeyAuth",
        "total": "1000"
    },
    "request": {
        "query": "GET",
        "resource": "price",
        "limit": "10",
        "offset": "0",
        "order": "DESC",
        "sort": "id",
        "state": "1",
        "type": "",
        "brand": "",
        "serie": "",
        "articul": "",
        "search": ""
    },
    "body": {
        "items": [
            {
                "item": {
                    "product_id": "",
                    "parent_id": "",
                    "brand_id": "",
                    "price": "",
                    "oldprice": "",
                    "available": "",
                    "guarantee": "",
                    "ean": "",
                    "category": {
                        "id": "",
                        "parent_id": "",
                        "name": "",
                        "alias": ""
                    },
                    "supplier": {
                        "id": "",
                        "dropshipping": "",
                        "pay_online": ""
                    },
                    "seller": {
                        "id": "",
                        "name": ""
                    },
                    "delivery": {
                        "terms": ""
                    },
                    "currency": {
                        "currency_id": "UAH",
                        "short_sign": "₴",
                        "name": "грн.",
                    },
                    "name": "",
                    "type": "",
                    "brand": "",
                    "serie": "",
                    "articul": "",
                    "url": "",
                    "image": {
                        "1": "",
                        "2": ""
                    },
                    "description": "-",
                    "param": {
                        "Гарантия": "12 месяцев",
                        "Страна производитель": "Украина"
                    }
		}
            }
         ]
    }
}
```

Поддержка, обратная связь, новости
----------------------------------

[](#поддержка-обратная-связь-новости)

Общайтесь с нами через почту

Если вы нашли баг в работе PLLANO REST API или PLLANO PHP HTTP client загляните в [issues](https://github.com/pllano/pllano-api/issues), возможно, про него мы уже знаем и чиним. Если нет, лучше всего сообщить о нём там. Там же вы можете оставлять свои пожелания и предложения.

За новостями вы можете следить по [коммитам](https://github.com/pllano/pllano-api/commits/master) в этом репозитории. [RSS](https://github.com/pllano/pllano-api/commits/master.atom).

Лицензия на библиотеку PLLANO REST API PHP
------------------------------------------

[](#лицензия-на-библиотеку-pllano-rest-api-php)

The MIT License (MIT). Please see [LICENSE](https://github.com/pllano/pllano-api/blob/master/LICENSE.md) for more information.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

3

Last Release

3103d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/83c4d844db99c883895755ca0e1dab41ba50f6e9faedbb972c2d35230a7dc0c2?d=identicon)[joomimart](/maintainers/joomimart)

---

Top Contributors

[![ruslan-avantis](https://avatars.githubusercontent.com/u/16430046?v=4)](https://github.com/ruslan-avantis "ruslan-avantis (180 commits)")

---

Tags

apipllanorestful-apiapipllano

### Embed Badge

![Health badge](/badges/pllano-api/health.svg)

```
[![Health](https://phpackages.com/badges/pllano-api/health.svg)](https://phpackages.com/packages/pllano-api)
```

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)