Универсальный класс-коннектор для BrainySoft Core

Общие сведения

Для любых обращений к BrainySoft Core необходимо получить у менеджера внедрения вашей организации авторизационные данные для подключения к API BrainySoft Core.

Для того, чтобы Вам было проще - мы подготовили специальный класс на языке PHP, который упрощает интеграцию Вашего проекта с BrainySoft. 

Скачать файл класса можно по ссылке

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

Для корректной работы класса необходимо вписать авторизационные данные в переменные $token и $core_url

token Авторизационный токен, это длиная строка, состоящая из цифр, букв латинского алфавита, математических символов
core_url Ссылка по которой отвечает ваша копия BrainySoft.

 

Краткое описание методов класса

Все методы, к которым можно обратиться при помощи методов класса представлены по ссылке http://docs.brainysoft.ru . Класс предлагает удобную обертку для упрощения обращения к описанным методам

GETRequest

Метод позволяет осуществлять HTTP GET запросы к API Brainysoft. GET Методы служат для получения информации из BrainySoft Core, например - получить данные клиента, контракта и так далее. 

При помощи этого метода можно вызвать, в частности (но не ограничиваясь) следующие методы:

http://docs.brainysoft.ru/page/353
http://docs.brainysoft.ru/page/373
http://docs.brainysoft.ru/page/396
http://docs.brainysoft.ru/page/451

Метод принимает следующие параметры: 

  • $url - относительная ссылка на GET метод ядра, перечень методов доступен по ссылке: http://docs.brainysoft.ru
  • $assoc - в каком виде возвращать ответ ядра. По-умолчанию (false) ответ возвращается в виде объекта или коллекции объектов. Если true - возвращается в виде массива.
POSTRequest

Метод позволяет осуществлять HTTP POST запросы к API Brainysoft. POST Методы служат для записи информации в BrainySoft Core, например - создать нового клиента, контракт и так далее.

При помощи этого метода можно вызвать, в частности (но не ограничиваясь) следующие методы:

http://docs.brainysoft.ru/page/356
http://docs.brainysoft.ru/page/376
http://docs.brainysoft.ru/page/445
http://docs.brainysoft.ru/page/453

Метод принимает следующие параметры: 

  • $url - относительная ссылка на POST метод ядра, перечень методов доступен по ссылке: http://docs.brainysoft.ru.
  • $data - данные, которые отправляются в POST метод. Может быть массивом, объетом или коллекцией.
  • $assoc -  в каком виде возвращать ответ ядра. По-умолчанию (false) ответ возвращается в виде объекта или коллекции объектов. Если true - возвращается в виде массива.
PUTRequest

Метод позволяет осуществлять HTTP POST запросы к API Brainysoft. POST Методы служат для записи информации в BrainySoft Core, например - исправить клиента, контракт и так далее.

При помощи этого метода можно вызвать, в частности (но не ограничиваясь) следующие методы:

http://docs.brainysoft.ru/page/357
http://docs.brainysoft.ru/page/377
http://docs.brainysoft.ru/page/446
http://docs.brainysoft.ru/page/454

Метод принимает следующие параметры:

  • $url - относительная ссылка на PUT метод ядра, перечень методов доступен по ссылке: http://docs.brainysoft.ru.
  • $data - данные, которые отправляются в PUT метод. Может быть массивом, объетом или коллекцией.
  • $assoc -  в каком виде возвращать ответ ядра. По-умолчанию (false) ответ возвращается в виде объекта или коллекции объектов. Если true - возвращается в виде массива.
DELETERequest

Метод позволяет осуществлять HTTP DELETE запросы к API Brainysoft. DELETE Методы служат для удаления информации из BrainySoft Core, например - удалить клиента, контракт и так далее.

При помощи этого метода можно вызвать, в частности (но не ограничиваясь) следующие методы:

http://docs.brainysoft.ru/page/358
http://docs.brainysoft.ru/page/386
http://docs.brainysoft.ru/page/401
 

Метод принимает следующие параметры:

  • $url - относительная ссылка на PUT метод ядра, перечень методов доступен по ссылке: http://docs.brainysoft.ru.
  • $data - данные, которые отправляются в PUT метод. Может быть массивом, объетом или коллекцией.
  • $assoc -  в каком виде возвращать ответ ядра. По-умолчанию (false) ответ возвращается в виде объекта или коллекции объектов. Если true - возвращается в виде массива.
contractCanIssue

Метод позволяет проверить готов ли контракт к выдаче (возможна ли выдача по контракту). 

Метод принимает параметр $contract в качестве аргумента. $contract - результат выпоолнения метода GETRequest для вот этого метода: http://docs.brainysoft.ru/page/396
contractCanRepay

Метод позволяет проверить готов ли контракт к погашению (возможно ли погашение по контракту). 

Метод принимает параметр $contract в качестве аргумента. $contract - результат выпоолнения метода GETRequest для вот этого метода: http://docs.brainysoft.ru/page/396