Работа с REST API
Пассворк включает в себя REST API, спроектированный для управления сейфами, папками и паролями. API основан на протоколе HTTPS и предоставляет ответы в формате JSON.
Работа с API состоит из трех основных этапов:
- Авторизация с использованием пользователя API-ключа и получение токенов для сессии API
- Выполнение операций
- Завершение сессии
Права доступа к API совпадают с правами пользователя, API-ключ которого используется. Все действия логируются от имени этого пользователя.
REST API взаимодействует с мобильными приложениями и браузерными расширениями Пассворка. Также API можно использовать для интеграции Пассворка в вашу инфраструктуру.
Для поддержки режима «zero knowledge» (клиентского шифрования), клиентская сторона должна быть способна расшифровать возвращаемые API данные, а также зашифровать данные перед их отправкой в API. Эти процессы подготовки данных является технически сложными и требует кодирования данных в определенные форматы, деривиации ключей из паролей, вычисления хеш-функций и использования шифрования RSA и AES. Для облегчения использования API, мы разработали специальные коннекторы, которые инкапсулируют в себе все необходимые действия и предоставляют простые интерфейсы для разработчиков.
На данный момент доступны коннекторы и примеры:
REST API позволяет
- производить CRUD-действия с паролями, папками, сейфами
- искать пароли по фразам и URL
У каждого пользователя есть свой API ключ. Получить его можно на странице Меню → Настройки API.
![Document image Document image](https://images.archbee.com/jvwmQL6VASLd-norgNd8V/FXlSx4O8b70lBKNj3Ku_b_image.png?format=webp)
Указывая API-ключ вы действуете от лица того пользователя, которому принадлежит этот API-ключ. Как только вы сбрасываете ключ, отключаете API или блокируете пользователя, доступ по API сразу закрывается.
Например, вы можете создать скрипты, которые будут выполнять действия от вашего лица (пользователя). Или создать специального сервисного пользователя, предоставив ему необходимые права и доступ.
Детальные примеры можно найти в репозиториях коннекторов:
Пример получения пароля по ID
💡 Что такое master password
Мастер-пароль — это дополнительный пароль пользователя, который используется для шифрования на клиентской стороне. Пропустите это поле, если вы не знаете где взять мастер-пароль.
![Doc contributor](https://s3.amazonaws.com/archbee-animals/gorilla.png)