Информация о домене аккаунта

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

До сентября 2024 года был доступен только метод для получения информации по Access Token, но из-за того, что срок жизни этого токена мал, мы добавили метод для получения информации по Refresh Token. Изменился адрес метода и добавилась необходимость передавать Refresh Token в заголовке X-Refresh-Token.

Получение информации о домене аккаунта по Refresh Token

Метод

GET /oauth2/account/current/subdomain

Описание

Метод позволяет получить информацию о домене аккаунта.
Метод может быть полезен в случае смены субдомена аккаунта, с которым вы работаете.
При наличии активного Refresh Token, вы можете сделать запрос к этому методу и получить информацию о домене аккаунта.

Запрос делается на домен, который зашит в Access Token, для его получения вы можете распарсить access token с помощью любой из библиотек для разбора JWT токенов и получить адрес из claim api_domain.

После получения адреса из access токена – нужно сделать запрос с этот домен и передачей заголовка X-Refresh-Token, где значением является активный Refresh Token.

Ограничения

Метод доступен только с активным Refresh Token’ом интеграции
Метод доступен только по поддомену из claim api_domain в Access Token.

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

Запрос должен уходить на host из claim api_domain в JWT Access Token: {api_domain}.amocrm.ru

curl 'https://api-a.amocrm.ru/oauth2/account/current/subdomain' -H 'X-Refresh-Token: {refresh_token}'

Заголовок типа данных при успешном результате

Content-Type: application/json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа	Условие
200	Запрос выполнен успешно
401	Пользователь не авторизован

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

Метод возвращает информацию о домене аккаунта, рассмотрим ниже свойства.

Параметр	Тип данных	Описание
id	int	ID аккаунта
subdomain	string	Судбомен аккаунта
domain	string	Полный домен аккаунта
top_level_domain	string	Домен верхнего уровня аккаунта (ru или com)

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

{
    "id": 123456,
    "subdomain": "account_subdomain",
    "domain": "account_subdomain.amocrm.ru",
    "top_level_domain": "ru"
}

Получение информации о домене аккаунта по Access Token (Устарел)