Password Pusher API v2

BETA

Исчерпывающая документация по REST API для интеграции Password Pusher в ваши рабочие процессы, приложения и инструменты.

Уведомление о бета-версии: API v2 в настоящее время находится в стадии бета-версии. Мы приложили все усилия для обеспечения стабильности, но до финального релиза возможны изменения. Мы приветствуем ваши отзывы!

Обзор

Password Pusher API v2 предоставляет REST-интерфейс для создания, получения и управления безопасными запросами паролей. Все конечные точки API возвращают ответы в формате JSON и используют стандартные коды состояния HTTP.

Аутентификация с помощью токена носителя

Защищенный доступ к API с помощью аутентификации на основе токенов

Ответы только в формате JSON

Согласованный формат JSON для всех конечных точек

RESTful Design

Интуитивно понятные конечные точки REST, соответствующие лучшим практикам

Нажатия и запросы

Поддержка односторонних толчков и двусторонних запросов

GET /api/v2/version

Возвращает текущую версию API, сведения о приложении и хэш возможностей, описывающий, какие возможности включены в данном экземпляре.

Пример запроса

curl -X GET https://us.pwpush.com/api/v2/version

Пример ответа

{
  "application_version": "2.1.0",
  "api_version": "2.1",
  "edition": "commercial",
  "features": {
    "anonymous_access": true,
    "api_token_authentication": true,
    "accounts": {
      "enabled": true
    },
    "pushes": {
      "enabled": true,
      "email_auto_dispatch": true,
      "file_attachments": {
        "enabled": true,
        "requires_authentication": true
      }
    },
    "requests": {
      "enabled": true,
      "email_auto_dispatch": true,
      "file_attachments": {
        "enabled": true,
        "requires_authentication": true
      }
    }
  }
}

Особенности Хаш

анонимный_доступ - Разрешено ли анонимное использование API

api_token_authentication - Поддержка аутентификации с помощью маркера носителя

учетные записи.включено - Доступен ли список рабочих пространств по адресу /api/v2/workspaces (старый путь /api/v2/accounts является псевдонимом)

pushes.enabled - Создание и управление пушами через API

pushes.email_auto_dispatch - Уведомления по электронной почте о создании push

pushes.file_attachments.enabled - Вложение файлов при нажатии кнопки

pushes.file_attachments.requires_authentication - Вложения файлов требуют проверки подлинности

requests.enabled - Создание и управление запросами через API

requests.email_auto_dispatch - Уведомления по электронной почте о создании запроса

requests.file_attachments.enabled - Вложения файлов в ответы на запросы

requests.file_attachments.requires_authentication - Вложения файлов требуют проверки подлинности

Пример: Создание и извлечение нажатия

# Create a push
curl -X POST https://us.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "MySecretPassword123",
      "expire_after_duration": 6,
      "expire_after_views": 3
    }
  }'

# Retrieve the push
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92

Пример: Создание запроса и ответ на него

# Create a request
curl -X POST https://us.pwpush.com/api/v2/requests \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request": {
      "request": "Please provide the API key",
      "close_after_duration": 8
    }
  }'

# Respond to the request
curl -X PATCH https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
  -H "Content-Type: application/json" \
  -d '{
    "request": {
      "response": "The API key is: sk_live_1234567890"
    }
  }'

Запросы государств

open Запрос создан и ожидает ответа. Поделитесь URL-адресом запроса с получателем.

ready Ответ был получен и доступен для получения. Теперь исходный запросчик может получить доступ к ответу.

closed Срок действия запроса истек или он был закрыт вручную. Все конфиденциальные данные были безвозвратно удалены.

Ограничение скорости применяется для защиты API от злоупотреблений и обеспечения справедливого использования для всех пользователей. Ограничения скорости применяются для каждого IP-адреса и зависят от типа запроса и конечной точки.

Предельные тарифы Ответы

Если запрос превышает лимит скорости, API возвращает сообщение 429 Too Many Requests код состояния с Retry-After заголовок, указывающий, когда можно повторить запрос.

Лучшие практики

Реализуйте экспоненциальный откат при получении ответа 429
Уважайте Retry-After значение заголовка
Кэшируйте ответы, когда это необходимо, чтобы сократить количество обращений к API
По возможности выполняйте пакетные операции вместо того, чтобы делать много отдельных запросов
Контролируйте использование API вашего приложения, чтобы избежать превышения лимитов

Примечание: Ограничения тарифов призваны предотвратить злоупотребления и в то же время разрешить законное использование. Если вы постоянно сталкиваетесь с ограничениями скорости, подумайте об оптимизации интеграции или обратитесь в службу поддержки для обсуждения вашего случая использования.

Последнее обновление: July 20, 2026

Password Pusher API v2

Обзор

Аутентификация с помощью токена носителя

Ответы только в формате JSON

RESTful Design

Нажатия и запросы

Аутентификация

Получение API-токена

Базовый URL

Доступность в бета-версии

Версия