API Mewayz Дополнение
Откройте для себя возможности интеграции API Mewayz для беспрепятственного управления проектами и задачами. Легко расширяйте и настраивайте. Попробуйте сейчас!
Введение
Генератор документов API — это мощное дополнение, которое предоставляет полную документацию по API для платформы Mewayz. Это дополнение помогает разработчикам и техническим группам получить доступ к подробной информации API, включая конечные точки, заголовки, параметры и примеры ответов. Документация охватывает 14 основных модулей платформы и позволяет пользователям создавать собственные приложения, интегрировать внешние системы или тестировать API вручную с помощью таких инструментов, как Postman.
Как включить этот модуль
Чтобы настроить надстройку API, вы можете перейти по этой ссылке: Настройка дополнения.
Как использовать надстройку API?
Создание документов API
После покупки и установки этого дополнения перейдите на боковую панель панели управления и найдите дополнение API Docs.
Чтобы получить доступ к документации API, перейдите в раздел «Документация API» на главной панели управления. Документация организована 14 модулей, что упрощает поиск конкретных API, необходимых для вашего проекта интеграции.
Этот раздел включает общее введение, объясняющее, как эффективно использовать API. В этом обзоре рассматриваются требования к аутентификации, общие заголовки и основные рекомендации по использованию, которые применяются ко всем конечным точкам API.
Каждый модуль содержит мощные списки API с полными техническими подробностями. Для каждой конечной точки API вы найдете имя API, точный URL-адрес конечной точки, необходимые заголовки для аутентификации и формата данных, входные параметры с их типами данных и правилами проверки, примеры успешных ответов, показывающие ожидаемую структуру данных, а также примеры ответов об ошибках с распространенными кодами ошибок и сообщениями.
Введение Управление
Эта подробная документация по API — ваш путь к использованию возможностей Mewayz, позволяющий оптимизировать вашу работу, повысить производительность и вывести ваши проекты на новый уровень.
Эта документация по API представляет собой ресурс для разработчиков, как опытных, так и новых, которые хотят использовать возможности Mewayz в своих приложениях. Вот что вы можете ожидать найти.
Вы можете просмотреть полную интерактивную справку внутри продукта в разделе Настройки → Документация по API.
В разделе «Конечные точки» описаны GET для получения данных, POST для создания новых данных, POST для обновления существующих данных и DELETE для удаления данных. Вы можете использовать методы HTTP, такие как GET, для получения данных, POST для создания новых данных, POST для обновления существующих данных и DELETE для удаления данных.
Параметры запроса используются для настройки поведения ваших запросов API и предоставления более подробной информации при взаимодействии с API. Для Mewayz у вас могут быть следующие типы параметров запроса: параметры запроса для фильтрации или сортировки данных при получении информации, заголовки запросов для аутентификации и дополнительных метаданных о запросе, а также тело запроса, содержащее данные JSON, которые необходимо создать или обновить.
API Mewayz обычно отвечает данными в формате JSON. Ответ обычно включает код состояния HTTP, указывающий результат запроса, а фактические данные содержатся в «данные» поле.
Управление аутентификацией
API-интерфейсы аутентификации предоставляют необходимые функции входа в систему, возможности обновления токенов для поддержания сеансов и процедуры выхода из системы для безопасного завершения сеансов пользователей.
Конечная точка входа в систему POST /api/login требует заголовков с «Принять»: «приложение/json» и параметры, включая электронную почту, например «[email protected]» и пароль типа **«john****»**.
Ответы об ошибках возвращают 422 Unprocessable Content с «успех»: ложь, «сообщение»: «Проверка Когда проверка является ошибкой.
Ответы об ошибках возвращают 400 Несанкционировано с «успех»: ложь, «сообщение»: “Предоставлено” когда учетные данные недействительны.
Успешные ответы на вход возвращают 200 OK с «успех»: true и авторизация, содержащая токен и тип «носитель» для последующих вызовов API.
Конечная точка обновления аутентификации POST/api/refresh использует заголовки авторизации с токеном носителя для управления сеансом.
Успешные ответы на обновление возвращают подробную информацию о пользователе, включая 200 ОК с «успех»: true, а также данные пользователя, идентификатор, имя, адрес электронной почты, mobile_no, тип: «компания», аватар: «URL», язык: «эн» и жетон.
Управление пользователями
- Пользовательские API для администрирования пользователей, управления ролями и профилями
операции.
Управление складом
- API-интерфейсы склада для настройки склада и перемещения склада
управление.
Управление продуктами и услугами
- API-интерфейсы раздела продуктов и услуг управляют категориями продуктов, налогами,
единицы измерения, продукты и управление запасами с интеграцией склада.
Управление счетами за покупку
- API-интерфейсы счетов-фактур покупок для списка счетов-фактур покупок, создания, детализации,
Обновление, удаление, управление публикацией счетов.
Управление возвратом покупок
- API для обработки списка возврата покупок, создания, сведений о возврате,
Удалить, Утвердить, Завершить обработку.
Управление торговыми предложениями
- API-интерфейсы торговых предложений для управления предложениями и их преобразования.
процессы.
Управление счетами за продажу
- API-интерфейсы счетов-фактур обрабатывают список счетов-фактур, создание, обновление, удаление,
Управление почтой счетов.
Управление возвратом счетов-фактур продаж
- API для управления списком возврата счетов-фактур, создания, детализации, удаления,
Утвердить и завершить.
Управление аккаунтом
- API раздела «Учетная запись» позволяют вам управлять клиентами, поставщиками,
- Модуль «Учетная запись» включает API быстрого списка для получения простых
Банковские счета, план счетов, доходы, расходы, кредит-ноты, дебет-ноты, платежи поставщикам, платежи клиентам, банковские операции, записи банковских переводов. Вы можете выполнять такие операции, как перечисление записей, создание новых записей, просмотр сведений, обновление информации и удаление записей по мере необходимости.
списки клиентов и поставщиков, список счетов Gl, а также категории доходов и расходов для выпадающего выбора и быстрых ссылок.
Управление проектами
- API-интерфейсы раздела проектов управляют проектами, задачами, ошибками, вехами,
файлы и различные отчеты со связанными с ними этапами и рабочими процессами.
POS-менеджмент
- POS API обрабатывают операции в точках продаж, включая управление заказами.
и Детали заказа.
CRM-менеджмент
- API-интерфейсы раздела CRM охватывают управление конвейерами, этапы лидов и сделок,
ярлыки, источники и полное управление потенциальными клиентами и управление сделками. Вы можете управлять задачами, пользователями, продуктами, источниками, электронными письмами, обсуждениями, файлами и звонками, связанными как с интересами, так и со сделками.
Управление персоналом
- API-интерфейсы HRM управляют сотрудниками, организационной структурой,
отслеживание посещаемости, управление отпусками, обработка заработной платы и различные записи кадров, включая награды, повышения по службе, отставки, увольнения, предупреждения, жалобы, переводы сотрудников, праздники, мероприятия, документы, объявления и благодарности.
Каждая конечная точка API в документации включает практические примеры, которые вы можете скопировать и использовать непосредственно в своей среде разработки или инструментах тестирования. В примерах ответов показаны как успешные операции, так и распространенные сценарии ошибок, что поможет вам реализовать правильную обработку ошибок в ваших приложениях.
Список модулей Wise API:
- Аутентификация:
- Авторизоваться
- Обновление токена
- Выход из системы
- Пользователь:
- Пользователь: Список, Создание, Обновление, Удаление,
- Роль: Список
- Журнал пользователя: Список
- Персональные пользователи: Список
- Пользователи клиента: Список
- Пользователи-продавцы: Список
- Склад:
Обновление профиля, обновление пароля, сброс пароля, проверка
- Склад: Список, Создать, Подробно, Обновить,
- Трансфер: Список, Создать данные запроса,
- Продукт и услуга:
Удалить
Создать, Удалить
- Категория продукта: Список, Создание, Обновление,
- Налог: Список, создание, обновление, удаление
- Единица: Список, создание, обновление, удаление
- Продукт: Список, Создать, Подробно, Обновить,
- Товар на складе: Список, Добавить
- Складская продукция: Список
- Счет за покупку:
Удалить
Удалить
- Счет: Список, Создать, Подробно, Обновить,
- Возврат покупки:
Удалить, Опубликовать
- Возврат: Список, Создать, Подробно, Удалить,
- Коммерческое предложение:
Утвердить, завершить
- Предложение: Список, Создать, Подробно, Обновить,
- Счет-фактура продажи:
Удалить, отправить, принять, отклонить, преобразовать в счет
- Счет: Список, Создать, Подробно, Обновить,
- Возврат счета-фактуры:
Удалить, Опубликовать
- Возврат: Список, Создать, Подробно, Удалить,
- Аккаунт:
Утвердить, завершить
- Получить клиентов: Простой список клиентов
- Получить поставщиков: Простой список поставщиков
- Клиент: Список, создание, обновление, удаление
- Продавец: Список, создание, обновление, удаление
- Гл Аккаунт: Список
- Банковский счет: Список, создание, обновление, удаление
- Категории дохода: Список
- Доход: Список, Создание, Обновление, Удаление,
- Категории расходов: Список
- Расход: Список, Создание, Обновление, Удаление,
- Типы счетов: Список
- План счета: Список
- Банковская транзакция: Список
- Банковский перевод: Список
- Платежи поставщикам: Список
- Платежи клиентов: Список
- Кредитное примечание: Список
- Дебетовое примечание: Список
- Проект:
Одобрить, опубликовать
Одобрить, опубликовать
- Проект: Список, Создать, Подробно, Обновить,
- Участник проекта: Удалить
- Клиент проекта: Список, Пригласить, Удалить
- Этап проекта: Список, Создание, Обновление,
- Файл проекта: Создать, Удалить
- Задача: Доска задач, Создание, Детализация, Обновление,
- Комментарий к задаче: Создать, Удалить
- Подзадача задачи: Создать, Обновить
- Статус ошибки: Список
- Ошибка: Список, Создать, Подробно, Обновить, Удалить
- Комментарий к ошибке: Создать, Удалить
- Отчет о проекте: Список, Подробности
- Этап задачи: Список, порядок, создание, обновление,
- Этап ошибки: Список, порядок, создание, обновление,
- ПОС:
Удалить
Удалить
Удалить
Удалить
Удалить
- Заказ: Список, Подробности
- CRM:
- Трубопровод: Список, создание, обновление, удаление
- Ведущий этап: Список, создание, обновление, удаление
- Стадия сделки: Список, создание, обновление, удаление
- Этикетки: Список, создание, обновление, удаление
- Источники: Список, создание, обновление, удаление
- Ведущий: Список, Создать, Подробно, Обновить,
- Ведущая задача: Создать, обновить, удалить
- Ведущий пользователь: Создать, Удалить
- Ведущий продукт: Создать, Удалить
- Ведущий источник: Создать, Удалить
- Ведущая электронная почта: Создать
- Ведущая дискуссия: Создать
- Ведущий файл: Создать, Удалить
- Ведущий звонок: Создать, обновить, удалить
- Сделка: Список, Создать, Подробно, Обновить,
- Задача сделки: Создать, обновить, удалить
- Пользователь сделки: Создать, Удалить
- Продукт сделки: Создать, Удалить
- Источник сделки: Создать, Удалить
- Электронная почта сделки: Создать
- Обсуждение сделки: Создать
- Файл сделки: Создать, Удалить
- Клиент сделки: Создать, Удалить
- Звонок по сделке: Создать, обновить, удалить
- УЧР:
Удалить, добавить метку, преобразовать в сделку
Удалить, добавить метку
- Сотрудник: Список, Создать, Подробно, Обновить,
- Посещаемость: Список, создание, обновление, удаление
- Типы отпусков: Список
- Оставляйте заявки: Список, Создание, Обновление,
- Остатки остатка: Проверить
- Заработная плата: Список, Подробности
- Расчетный лист: Генерировать
- Смены: Список
- Филиалы: Список
- Отделы: Список
- Обозначения: Список
- Типы документов: Список
- Праздники: Список
- Награды: Список
- Акции: Список
- Отставки: Список
- Прекращение: Список
- Предупреждения: Список
- Жалобы: Список
- Переводы сотрудников: Список
- Документы: Список
- Благодарности: Список
- Объявления : Список
- События : Список
Удалить
Удалить, обновить статус