Ограничения и рекомендации

Общие правила работы с API

Все общение с API происходит в зашифрованном виде по протоколу SSL. Это значит что все ссылки к API должны содержать протокол HTTPS. Особенно важно помнить это при обращении через JS, если вы обращаетесь к каким-то сторонним ресурсам, к примеру, обращаетесь к WEB-сокету. Внутри системы пользователь всегда находится в защищенном соединении и попытка обратится к HTTP картинке будет заблокирована или браузер пользователя выдаст ему предупреждение.

API-ключ (хэш), используемый для авторизациия в API крайне желательно обновлять, используя форму смены пароля. Если ключ не обновляется в течение полугода, система оставляет за собой право сделать это в автоматическом режиме. Также стоит отметить, что API ключ пользователя меняется при смене логина или пароля без предупреждения.

Все запросы необходимо производить не на общий домен http://www.amocrm.ru, а на точный адрес вашего аккаунта, например, https://company.amocrm.ru.

Поддерживаемые протоколы

Для работы с нашим API необходима поддержка одного из следующих криптографических протоколов: TLS 1.1, TLS 1.2 Рекомендуемой версией является TLS 1.2

Начиная с 16.11.2016 мы полностью отказываемся от поддержки протокола SSLv3, в связи с тем, что данный протокол считается уязвивым.

Библиотека cURL поддерживает протокол TLS 1.1/1.2, начиная с версии 7.34.0. В параметрах сеанса cURL можно явно указать версию протокола:

  1. $curl=curl_init(); #Сохраняем дескриптор сеанса cURL
  2. curl_setopt($curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);

Ограничения

Предусмотрены механизмы ограничения активности работы с API - не более 1 запроса в секунду, а также в некоторых методах предусмотрены ограничения на количества возвращаемых за один запрос данных (подробнее в описании конкретных методов).

В случае подозрительной активности через API или сбоя интеграции, доступ к API аккаунта может быть заблокирован. Например при выборке одних и тех же раз за короткий промежуток времени, бесконтрольный перебор всех данных (Советуем использовать заголовок If-Modified-Since при работе со списками сделок/контактов/компаний/задач.

В случае превышения количества запросов - будет возвращаться HTTP код 429, при многократном нарушении ограничений, аккаунт блокируется и на любой запрос в API будет возвращаться HTTP код 403.

В случае окончания подписки, доступ к данным через API будет закрыт через 30 дней после окончания подписки. В ответ на запросы сервер будет возвращать HTTP код 402.

Максимальное кол-во возвращаемых сущностей (сделок/контактов/компаний/покупателей) не более 500.