API и интеграции iBox
iBox предоставляет API для интеграции с внешними системами: сайтами, CRM, мобильными приложениями и другими сервисами.
С помощью API вы можете:
- получать данные о товарах, клиентах и документах;
- создавать заказы, отгрузки и другие операции;
- автоматизировать бизнес-процессы;
- интегрировать iBox с вашими внутренними системами.
Как получить API-ключ
API-ключ используется для авторизации при работе с API.
Создать ключ может только пользователь с правами администратора.
Шаги
- Нажмите на название организации в верхней панели.
- Выберите Управление.
- В левой панели перейдите в раздел Настройки.
- Откройте раздел Ключи API.
- Нажмите Плюс.
- Заполните:
- Название ключа — для удобства идентификации;
- Организации — выберите, к каким организациям будет доступ.
- Нажмите Сохранить.
- Скопируйте сгенерированный ключ.
Важно
Сохраните API-ключ сразу после создания.
После закрытия окна вы не сможете посмотреть его повторно.
Если ключ утерян — потребуется создать новый.
Управление API-ключами
Как деактивировать ключ
Если ключ больше не используется или требуется ограничить доступ:
- Откройте Управление → Настройки → Ключи API.
- Найдите нужный ключ.
- Нажмите на меню ⋮ (три точки) справа.
- Выберите Отключить.
После деактивации ключ перестанет работать.
Рекомендации по безопасности
- не передавайте API-ключ третьим лицам;
- храните ключи в защищенном месте (например, в переменных окружения);
- используйте отдельные ключи для разных интеграций;
- при подозрении на компрометацию немедленно отключите ключ и создайте новый.
Документация API
Полное описание методов API, параметров и примеров запросов доступно по ссылке:
https://docsify.smpro.uz/docs/
Рекомендуется ознакомиться с документацией перед началом интеграции.