readme
This commit is contained in:
parent
bd62c0fa3c
commit
bb38b5e970
27
README.md
27
README.md
|
|
@ -1 +1,26 @@
|
||||||
#Класс для работы с API CRM "Клиентская База" и пример использования
|
# Класс для работы с API CRM "Клиентская База" и пример использования
|
||||||
|
|
||||||
|
### Подключите класс src/ClientbaseAPI для работы с API:
|
||||||
|
|
||||||
|
```
|
||||||
|
$cbAPI = new ClientbaseAPI('[URL вашей CRM]', '[Токен для доступа к API']);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Пример: получить список всех пользовательских таблиц
|
||||||
|
|
||||||
|
```
|
||||||
|
$tables = $cbAPI->getTablesList();
|
||||||
|
|
||||||
|
foreach ($tables as $table) {
|
||||||
|
echo 'Таблица с id=' . $table->id . ' называется $table->attributes->table_name . '<br/>';
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Примеры решения разных задач Вы можете найти в файле `index.php`.
|
||||||
|
|
||||||
|
|
||||||
|
### Вы можете использовать следующие методы для работы с API:
|
||||||
|
|
||||||
|
* getTablesList()
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
{
|
||||||
|
"name": "clientbase/api",
|
||||||
|
"type": "library",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "This will helps you with Client Base API.",
|
||||||
|
"homepage": "https://github.com/clientbase-doc/api",
|
||||||
|
"license": "MIT",
|
||||||
|
"authors": [
|
||||||
|
{
|
||||||
|
"name": "clientbase.ru",
|
||||||
|
"role": "Developer"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"require": {
|
||||||
|
"php": ">=7.3"
|
||||||
|
},
|
||||||
|
"autoload": {
|
||||||
|
"psr-4": {
|
||||||
|
"clientbase\\api\\": "src"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Подключаем класс для работы с API
|
//Подключаем класс для работы с API
|
||||||
require_once "../api/dev/ClientbaseAPI.php";
|
require_once "src/ClientbaseAPI.php";
|
||||||
|
|
||||||
//Укажите URL вашей "Клиентской Базы"
|
//Укажите URL вашей "Клиентской Базы"
|
||||||
$url = 'http://localhost/distr';
|
$url = 'http://localhost/distr';
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
namespace clientbase\api;
|
||||||
|
|
||||||
class ClientbaseAPI
|
class ClientbaseAPI
|
||||||
{
|
{
|
||||||
|
|
||||||
Loading…
Reference in New Issue