API AgencyHandy: аутентификация и начало работы

API AgencyHandy позволяет автоматизировать создание лидов, управление клиентами, обновление заказов и многое другое из любой внешней системы или скрипта. Каждый запрос аутентифицируется с помощью API-ключа, который вы генерируете в настройках рабочего пространства. В этом руководстве описан процесс получения учётных данных и выполнения первого API-вызова.

Для генерации API-ключа необходимо иметь роль SuperAdmin или Admin в вашем рабочем пространстве AgencyHandy.

Базовый URL

Все API-запросы выполняются по адресу:

https://api.agencyhandy.com

Замените {{URL}} этим базовым URL во всех примерах запросов в документации по API.

Шаг 1: Сгенерируйте API-ключ

Откройте настройки рабочего пространства

Перейдите в настройки рабочего пространства по адресу:

{{workspaceUrl}}/workspace-config?tab=api-key

Откроется вкладка API-ключ в разделе «Настройки рабочего пространства».

Сгенерируйте и скопируйте API-ключ

Нажмите Сгенерировать (или Перегенерировать, если ключ уже существует). Скопируйте API-ключ и сохраните его в надёжном месте — обращайтесь с ним как с паролем. AgencyHandy не покажет его повторно после того, как вы покинете страницу.

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

Шаг 2: Получите идентификатор компании

Большинство конечных точек API требуют заголовка companyid, который определяет, на какое рабочее пространство направлен запрос. Используйте следующую конечную точку для получения идентификатора компании.

Конечная точка

GET {{URL}}/accounts/companies

Заголовки

Заголовок	Значение
`x-api-key`	Ваш API-ключ

Пример запроса

cURL

curl --request GET "https://api.agencyhandy.com/accounts/companies" \
  --header "x-api-key: <YOUR_API_KEY>"

Пример ответа

{
  "message": "Companies associated with API token.",
  "companies": [
    {
      "_id": "6525994184e9ddd79853450e",
      "name": "onethread123",
      "logo": "",
      "extraSmallLogo": "",
      "largeLogo": ""
    }
  ]
}

Найдите идентификатор компании

В ответе найдите поле _id внутри массива companies. Это ваш идентификатор компании.

const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"

Сохраните идентификатор компании

Сохраните идентификатор компании для использования во всех последующих API-запросах. Вы будете передавать его в заголовке companyid:

Заголовок	Значение
`x-api-key`	Ваш API-ключ
`companyid`	Ваш идентификатор компании

Сводка по аутентификации

Каждый аутентифицированный API-запрос требует как минимум:

x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>

Имея API-ключ и идентификатор компании, вы готовы к использованию остальной части API AgencyHandy. Перейдите к одному из руководств по конечным точкам ниже.

Введение

Эндпоинты

API AgencyHandy: аутентификация и начало работы

Базовый URL

Шаг 1: Сгенерируйте API-ключ

Шаг 2: Получите идентификатор компании

Конечная точка

Заголовки

Пример запроса

Пример ответа

Сводка по аутентификации

​Базовый URL

​Шаг 1: Сгенерируйте API-ключ

​Шаг 2: Получите идентификатор компании

​Конечная точка

​Заголовки

​Пример запроса

​Пример ответа

​Сводка по аутентификации

Базовый URL

Шаг 1: Сгенерируйте API-ключ

Шаг 2: Получите идентификатор компании

Конечная точка

Заголовки

Пример запроса

Пример ответа

Сводка по аутентификации