Update README (#63)
This commit is contained in:
parent
2e4e24f507
commit
0951e3cfb3
13
README.md
13
README.md
@ -1,12 +1,11 @@
|
|||||||
[![Build Status](https://img.shields.io/travis/retailcrm/api-client-php/master.svg?style=flat-square)](https://travis-ci.org/retailcrm/api-client-php)
|
[![Build Status](https://img.shields.io/travis/retailcrm/api-client-php/master.svg?style=flat-square)](https://travis-ci.org/retailcrm/api-client-php)
|
||||||
[![Downloads](https://img.shields.io/packagist/dt/retailcrm/api-client-php.svg?style=flat-square)](https://packagist.org/packages/retailcrm/api-client-php/stats)
|
|
||||||
[![Latest stable](https://img.shields.io/packagist/v/retailcrm/api-client-php.svg?style=flat-square)](https://packagist.org/packages/retailcrm/api-client-php)
|
[![Latest stable](https://img.shields.io/packagist/v/retailcrm/api-client-php.svg?style=flat-square)](https://packagist.org/packages/retailcrm/api-client-php)
|
||||||
|
[![PHP from Packagist](https://img.shields.io/packagist/php-v/retailcrm/api-client-php.svg?style=flat-square)](https://packagist.org/packages/retailcrm/api-client-php)
|
||||||
|
|
||||||
|
|
||||||
# retailCRM API PHP client
|
# retailCRM API PHP client
|
||||||
|
|
||||||
PHP-client for [retailCRM API](http://www.retailcrm.pro/docs/Developers/ApiVersion5).
|
This is php retailCRM API client. This library allows to use all available API versions. [API documentation](http://retailcrm.github.io/api-client-php)
|
||||||
|
|
||||||
Use [API documentation](http://retailcrm.github.io/api-client-php)
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@ -105,3 +104,9 @@ if ($response->isSuccessful() && 201 === $response->getStatusCode()) {
|
|||||||
//}
|
//}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
* [English](http://www.retailcrm.pro/docs/Developers/Index)
|
||||||
|
* [Russian](http://www.retailcrm.ru/docs/Developers/Index)
|
||||||
|
* [API documentation](http://retailcrm.github.io/api-client-php)
|
||||||
|
105
README.ru.md
105
README.ru.md
@ -1,105 +0,0 @@
|
|||||||
# PHP-клиент для retailCRM API
|
|
||||||
|
|
||||||
PHP-клиент для работы с [retailCRM API](http://www.retailcrm.ru/docs/Developers/ApiVersion5).
|
|
||||||
|
|
||||||
Рекомендуем обращаться к [документации](http://retailcrm.github.io/api-client-php) по библиотеке, в частности по классу [RetailCrm\ApiClient](http://retailcrm.github.io/api-client-php/class-RetailCrm.ApiClient.html).
|
|
||||||
|
|
||||||
## Обязательные требования
|
|
||||||
|
|
||||||
* PHP версии 5.4 и выше
|
|
||||||
* PHP-расширение cURL
|
|
||||||
|
|
||||||
## Установка
|
|
||||||
|
|
||||||
1) Установите [composer](https://getcomposer.org/download/)
|
|
||||||
|
|
||||||
2) Выполните в папке проекта:
|
|
||||||
```bash
|
|
||||||
composer require retailcrm/api-client-php ~5.0
|
|
||||||
```
|
|
||||||
|
|
||||||
В конфиг `composer.json` вашего проекта будет добавлена библиотека `retailcrm/api-client-php`, которая установится в папку `vendor/`. При отсутствии файла конфига или папки с вендорами они будут созданы.
|
|
||||||
|
|
||||||
В случае, если до этого в вашем проекте не использовался `composer`, подключите файл автозагрузки вендоров. Для этого укажите в коде проекта:
|
|
||||||
```php
|
|
||||||
require 'path/to/vendor/autoload.php';
|
|
||||||
```
|
|
||||||
|
|
||||||
## Примеры использования
|
|
||||||
|
|
||||||
### Получение информации о заказе
|
|
||||||
```php
|
|
||||||
$client = new \RetailCrm\ApiClient(
|
|
||||||
'https://demo.retailcrm.ru',
|
|
||||||
'T9DMPvuNt7FQJMszHUdG8Fkt6xHsqngH',
|
|
||||||
\RetailCrm\ApiClient::V5
|
|
||||||
);
|
|
||||||
|
|
||||||
try {
|
|
||||||
$response = $client-request->ordersGet('M-2342');
|
|
||||||
} catch (\RetailCrm\Exception\CurlException $e) {
|
|
||||||
echo "Сетевые проблемы. Ошибка подключения к retailCRM: " . $e->getMessage();
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($response->isSuccessful()) {
|
|
||||||
echo $response->order['totalSumm'];
|
|
||||||
// или $response['order']['totalSumm'];
|
|
||||||
// или
|
|
||||||
// $order = $response->getOrder();
|
|
||||||
// $order['totalSumm'];
|
|
||||||
} else {
|
|
||||||
echo sprintf(
|
|
||||||
"Ошибка получения информации о заказа: [Статус HTTP-ответа %s] %s",
|
|
||||||
$response->getStatusCode(),
|
|
||||||
$response->getErrorMsg()
|
|
||||||
);
|
|
||||||
|
|
||||||
// получить детализацию ошибок
|
|
||||||
//if (isset($response['errors'])) {
|
|
||||||
// print_r($response['errors']);
|
|
||||||
//}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Создание заказа
|
|
||||||
```php
|
|
||||||
|
|
||||||
$client = new \RetailCrm\ApiClient(
|
|
||||||
'https://demo.retailcrm.ru',
|
|
||||||
'T9DMPvuNt7FQJMszHUdG8Fkt6xHsqngH',
|
|
||||||
\RetailCrm\ApiClient::V4
|
|
||||||
);
|
|
||||||
|
|
||||||
try {
|
|
||||||
$response = $client-request->ordersCreate(array(
|
|
||||||
'externalId' => 'some-shop-order-id',
|
|
||||||
'firstName' => 'Vasily',
|
|
||||||
'lastName' => 'Pupkin',
|
|
||||||
'items' => array(
|
|
||||||
//...
|
|
||||||
),
|
|
||||||
'delivery' => array(
|
|
||||||
'code' => 'russian-post',
|
|
||||||
)
|
|
||||||
));
|
|
||||||
} catch (\RetailCrm\Exception\CurlException $e) {
|
|
||||||
echo "Сетевые проблемы. Ошибка подключения к retailCRM: " . $e->getMessage();
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($response->isSuccessful() && 201 === $response->getStatusCode()) {
|
|
||||||
echo 'Заказ успешно создан. ID заказа в retailCRM = ' . $response->id;
|
|
||||||
// или $response['id'];
|
|
||||||
// или $response->getId();
|
|
||||||
} else {
|
|
||||||
echo sprintf(
|
|
||||||
"Ошибка создания заказа: [Статус HTTP-ответа %s] %s",
|
|
||||||
$response->getStatusCode(),
|
|
||||||
$response->getErrorMsg()
|
|
||||||
);
|
|
||||||
|
|
||||||
// получить детализацию ошибок
|
|
||||||
//if (isset($response['errors'])) {
|
|
||||||
// print_r($response['errors']);
|
|
||||||
//}
|
|
||||||
}
|
|
||||||
```
|
|
Loading…
Reference in New Issue
Block a user