Download the PHP package ufee/amoapi without Composer

On this page you can find all versions of the php package ufee/amoapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
ufee/amoapi
Rate from 1 - 5
Rated 5.00 based on 1 reviews

Example code of ufee/amoapi

Informations about the package amoapi

AmoCRM API Client

Api клиент для работы с amoCRM
Поддержка oAuth авторизации начиная с версии 0.9.0.0

Установка

Запуск тестов

Отредактировать vendor/ufee/amoapi/tests/Config.php

Инициализация клиента по oAuth

Хранение oauth токена возможно в нескольких вариантах

Файловое хранилище

Используется по умолчанию (/vendor/ufee/amoapi/src/Cache/), можно задать свой путь
Создается поддиректория: {path}/{domain}/{client_id}.json
Настоятельно рекомендуется использовать cвой путь для кеширования, в противном случае данные будут УДАЛЕНЫ composer'ом при обновлении на новую версию.

Redis

Поддерживается библиотека phpredis
Формат ключа: {domain}_{client_id}

MongoDB

Поддерживается библиотека mongodb

Наследование хранилища

Реализуется класс, наследующий \Ufee\Amo\Base\Storage\Oauth\AbstractStorage

Стороннее хранение

Кеширование oauth данных библиотекой не производится

Deprecated

Задать свой путь для кеширования oauth данных (устаревший метод)

Получение объекта для работы с конкретным аккаунтом

Получение ранее инициализированного объекта по id приложения

Получение URL авторизации в приложении amoCRM
Необходимо для извлечения кода авторизации

Получение oauth данных - access_token, refresh_token производится единоразово, по коду авторизации
Полученные данные oauth кешируются в соответствии с выбранным хранилищем
Применяются при API запросах автоматически

При необходимости можно задать oauth данные принудительно, вручную
Данные также будут кешированы автоматически в соответствии с выбранным хранилищем

Токен доступа обновляется автоматически, если срок действия refresh_token не истек
При необходимости можно обновить oauth данные по refresh_token принудительно, вручную
Новые oauth данные также будут кешированы автоматически

Вызов callback функции при автоматическом обновлении токена доступа

После первичного выполнения метода fetchAccessToken(), можно пользоваться клиентом в обычном режиме
Повторное выполнение метода fetchAccessToken() или setOauth() необходимо только в случаях, если: 1) Изменились ключи доступа в приложении 2) Изменился поддомен amoCRM аккаунта 3) Истек срок действия refresh_token 4) Получена ошибка авторизации

Рекомендуется убедиться в отсутствии публичного доступа к папке с кешем - /vendor/ufee/amoapi/src/Cache/
(если используется директория по умолчанию)

Обмен API ключа на код авторизации oAuth

Инициализация клиента по API-hash

Получение объекта для работы с конкретным аккаунтом

Включение/выключение автоматической авторизации при ошибке 401
Сессия (cookie) кешируется в файлах

Работа с клиентом

Включение логирования заросов (Logs/m-Y/domain.log)

или

Не более 1 запроса за заданное время, в секундах

Запрос /api/v2/account кешируется в файлах, время указывается в секундах

Пользовательская отладка запросов (обновлено с вводом oAuth)

Кеширование запросов

Хранение кеша возможно в нескольких вариантах

Файловое хранилище

Используется по умолчанию (/vendor/ufee/amoapi/src/Cache/), можно задать свой путь
Создаются кеш-файлы: {path}/{domain}_{hash}.cache
Настоятельно рекомендуется использовать cвой путь для кеширования, в противном случае данные будут УДАЛЕНЫ composer'ом при обновлении на новую версию.

Redis

Поддерживается библиотека phpredis
Формат ключа: {domain}-cache:{hash}

Поиск сущностей

Поиск по дополнительному полю

Работа с дополнительными полями

Убрать значение

Получить значение

Задать значение

Работа с коллекциями

Перебор, поиск и фильтрация

Сортировка

Дополнительно

Работа со сделками

Получение всех сделок

Получение по дате последнего изменения

Получение по ID

Получение сделок с дополнительным условием

Связанные сущности по сделке

Создание сделок

Создание сделки из контакта

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

Работа с контактами

Получение всех контактов

Получение по ID

Получение контактов с дополнительным условием

Связанные сущности по контакту

Создание контактов

Создание контакта из сделки

Копирование контакта

Работа с компаниями

Получение всех компаний

Получение по ID

Получение компаний с дополнительным условием

Связанные сущности по компании

Создание компаний

Создание компании из контакта или сделки

Копирование компании

Работа с задачами

Получение всех задач

Получение по ID

Получение задач с дополнительным условием

Создание задач

Создание задачи из контакта, сделки или компании

Получение родительского контакта, сделки или компании

Работа с примечаниями

Получение всех примечаний

Получение примечаний по ID и типу сущности

Получение примечаний с дополнительным условием

Создание примечаний

Создание примечания из контакта, сделки или компании

Закрепление/открепление примечаний (note type 4)

Получение содержимого файла (note type 5)

Получение родительского контакта, сделки или компании

Работа со списками

Получение всех списков (каталогов)

Получение по ID

Получение списков с дополнительным условием

Связанные сущности по списку

Создание списков

Удаление списков

Работа с элементами каталога (товарами)

Получение товаров

Добавление товаров

или

Обновление товаров

Связанные сущности по товару

Удаление товаров

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

Работа с покупателями

Получение всех покупателей

Получение по ID

Получение покупателей с дополнительным условием

Связанные сущности покупателя

Создание покупателей

Создание покупателя из контакта

Удаление покупателей

Работа с покупками

Получение транзакций (покупок)

Добавление транзакций

или

Обновление комментариев транзакций покупателя

Удаление транзакций покупателей

Работа с веб-хуками

Получение вебхуков (webhooks)

Добавление вебхуков

Удаление вебхуков

Работа с frontend методами

Скачивание файла из примечания

Выполнение произвольных запросов

Работа с Salesbot

All versions of amoapi with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ufee/amoapi contains the following files

Loading the files please wait ....