Настройки. API в Админ24
Чтобы настроить функционал REST API, перейдите в раздел «Настройки» на вкладку «API».
На странице располагаются ссылки на документацию по REST API:
Вы можете использовать ту документацию, с которой вам будет удобнее работать.
Документация elements для вашей организации расположена здесь:
Документация elements для вашей организации расположена здесь:
URL сервера, на который будут идти API запросы для вашей организации, прописан в документации.
Документация swagger-ui для вашей организации расположена здесь:
Документация swagger-ui для вашей организации расположена здесь:
В разделе можно настроить REST API для создания заявок из любых веб-форм. Сделать это можно по подробной инструкции.
Доступны следующие методы:
- получение текущего пользователя;
- получение списка пользователей организации;
- получение списка заявок;
- получение информации о заявке по ее UUID или ID;
- получение списка комментариев к заявке;
- получение комментария к заявке;
- создание заявки;
- удаление заявки (в корзину или полностью);
- получение списка мессенджеров Телеграм;
- получение списка статусов;
- получение отчета по расходным материалам;
- получение отчета по оборудованию;
- получение отчета по заявкам;
- получение отчета по метрикам;
- изменение приоритета заявки;
- обновление услуги у заявки;
- обновление полей заявки;
- получение списка тегов организации;
- добавление/удаление тега у заявки;
- изменение статуса заявки;
- добавление комментария к заявке;
- импорт заявок и прикрепленных к ним файлов;
- импорт комментариев и прикрепленных к ним файлов.
В разделе также можно подписаться на события через API
Доступны следующие события:
Доступны следующие события:
- обновление заявки;
- создание заявки;
- удаление заявки;
- обновление комментария;
- создание комментария.
- API для работы с событиями:
POST /api/add-callback – добавление или изменения обработчика событий для получения событий на внешний URL.
GET /api/callbacks – получение текущих обработчиков событий.
POST /api/delete-callback – удаление обработчиков событий.С помощью API POST /api/add-callback можно подписаться на следующие события:
ticket_created – событие возникает при создании заявки.
ticket_updated – событие возникает при изменении свойств заявки.
ticket_deleted – событие возникает при полном удалении заявки (удаление без перемещения в корзину или полное удаление из корзины).
comment_created – событие возникает при создании комментария к заявке.
comment_updated – событие возникает при изменении комментария к заявке.События на callback_url отправляются с помощью POST запросов. На странице с описанием API POST /api/add-callback есть описания тел запросов в разделе Callbacks.
При создании обработчика событий есть возможность указать secret_key Если он был указан, то к каждому событию запросу на callback_url будет добавляться заголовок X-Admin24-Secret-Key: [secret_key] с этим secret_key.
При создании обработчика событий есть возможность указать secret_key Если он был указан, то к каждому событию запросу на callback_url будет добавляться заголовок X-Admin24-Secret-Key: [secret_key] с этим secret_key.
Что делать, если возникли сложности?
Позвоните нам по телефону: 8 (800) 333-66-24, напишите на электронную почту: admin24@infoservice.ru или в Telegram. Принимаем звонки в любое время с 09:30 до 18:00 с понедельника по пятницу.
Мы поможем и расскажем, как настроить Admin24 под ваши нужды.
Мы поможем и расскажем, как настроить Admin24 под ваши нужды.