API-ключи, уровни доступа и тестовый режим
Короткий ответ
В Pro и Team API-ключи создаются в личном кабинете в разделе «Домен и API». У каждого ключа есть уровень доступа («Только чтение», «Чтение и запись» или «Полный доступ») и режим: боевые ключи (pf_live_) работают по-настоящему, тестовые (pf_test_) никогда не отправляют писем, а их передачи истекают через 24 часа.
API Pandafile позволяет вашим приложениям, скриптам и серверам отправлять файлы, собирать загрузки и запрашивать подписи. Он входит в Pro и Team и работает с теми же ограничениями, что и сайт. Всё начинается с API-ключа.
Как создать ключ
- Войдите и откройте в личном кабинете раздел «Домен и API».
- В блоке «API-ключи» дайте ключу название, например «Загрузки с сайта».
- Выберите режим ключа – «Боевой» или «Тестовый» – и доступ ключа: «Полный доступ», «Чтение и запись» или «Только чтение».
- Нажмите «Создать ключ» и сразу скопируйте его. В целях безопасности мы показываем ключ только один раз.
- Передавайте его в каждом запросе в заголовке Authorization: Bearer, за которым следует ключ.
Можно иметь до 10 активных ключей. Боевые ключи начинаются с pf_live_, тестовые – с pf_test_. Руководство для разработчиков – на pandafile.co/developers, справочник API – на pandafile.co/developers/api.
Уровни доступа: что может ключ
- «Только чтение»: только GET-запросы. Ключ может получать данные, но ничего не меняет.
- «Чтение и запись»: всё, что даёт «Только чтение», плюс создание, изменение и удаление передач, запросов файлов, запросов подписи и подписок на вебхуки.
- «Полный доступ»: всё, включая настройки аккаунта, например брендинг и приглашения в команду.
Тестовый режим
- Передачи, созданные ключом pf_test_, – это тестовые данные. Никому никогда не приходят письма, даже получателям, которых вы добавили.
- Тестовые передачи всегда истекают через 24 часа после создания, и продлить их нельзя.
- Они не учитываются ни в каких лимитах, хранилище или использовании и не показываются в обычных списках передач.
- В событиях вебхуков о них livemode = false, и они никогда не попадают в Slack, Microsoft Teams или Discord.
- Некоторые действия работают только с боевым ключом. С тестовым ключом API в таком случае отвечает ошибкой test_mode_unsupported.
Храните ключи в безопасности
- Любой, у кого есть ключ, может отправлять файлы от имени вашего аккаунта. Храните ключи на сервере и никогда не помещайте их в публичный код сайта или приложения.
- Если ключ мог утечь, отзовите его в личном кабинете в разделе «Домен и API». Приложения, которые им пользуются, сразу перестанут работать, а подписки на вебхуки, созданные с ним, например Zapier или Make, тоже остановятся.
- У каждого ключа свой лимит запросов. Каждый ответ показывает текущее состояние в заголовках RateLimit.
- В команде API-ключи личные: каждый участник создаёт свои.