Password Pusher API v2

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

Аутентификация запросов с помощью маркера Bearer в заголовке Authorization.

Создайте токен API в настройках вашей учетной записи по адресу /users/token.

Authorization: Bearer YOUR_API_TOKEN

• Общественные конечные пункты: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
• Аутентифицированные конечные точки: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
• Настройка анонимного доступа: Если анонимные проталкивания отключены, конечные точки API требуют аутентификации.

Базовый URL

Все конечные точки указаны относительно узла установки:

https://pwpush.leerinc.com/api/v2

Версия Конечная точка

GET /api/v2/version

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

пример cURL:

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

{
  "application_version": "2.6.6",
  "api_version": "2.1",
  "edition": "oss",
  "features": {
    "anonymous_access": true,
    "api_token_authentication": true,
    "accounts": {
      "enabled": false
    },
    "pushes": {
      "enabled": true,
      "email_auto_dispatch": false,
      "file_attachments": {
        "enabled": true,
        "requires_authentication": true
      },
      "url_pushes": {
        "enabled": true
      },
      "qr_code_pushes": {
        "enabled": true
      }
    },
    "requests": {
      "enabled": false
    }
  }
}

POST /api/v2/pushes

Создайте новый толчок.

Формат тела: { "push": { ... } }

{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

пример cURL (тело в формате JSON):

curl -X POST https://pwpush.leerinc.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "my-secret",
      "expire_after_days": 1,
      "expire_after_views": 5
    }
  }'

GET /api/v2/pushes/:url_token

Получение полезной нагрузки push по маркеру. Это считается просмотром и может привести к истечению срока действия push при достижении лимитов.

Параметры запроса: passphrase (необязательно, требуется, если push защищен парольной фразой)

пример cURL:

curl -X GET https://pwpush.leerinc.com/api/v2/pushes/YOUR_URL_TOKEN

GET /api/v2/pushes/:url_token/preview

Возвращает полный секретный URL-адрес для push без получения его полезной нагрузки.

пример cURL:

curl -X GET https://pwpush.leerinc.com/api/v2/pushes/YOUR_URL_TOKEN/preview

GET /api/v2/pushes/:url_token/audit

Возвращает записи журнала аудита для толчка. Требуется аутентификация и право собственности.

Параметры запроса: page (необязательно, целое число, по умолчанию 1, допустимый диапазон от 1 до 200)

пример cURL:

curl -X GET "https://pwpush.leerinc.com/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Немедленное истечение срока действия push. Разрешено для владельцев (при аутентификации) или для получателей, если push был создан с включенной функцией deletable_by_viewer.

пример cURL:

curl -X DELETE https://pwpush.leerinc.com/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

Список активных толчков для аутентифицированного пользователя.

Параметры запроса: page (необязательно, целое число, по умолчанию 1, допустимый диапазон от 1 до 200)

пример cURL:

curl -X GET "https://pwpush.leerinc.com/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Список истекших пушей для аутентифицированного пользователя.

Параметры запроса: page (необязательно, целое число, по умолчанию 1, допустимый диапазон от 1 до 200)

пример cURL:

curl -X GET "https://pwpush.leerinc.com/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Коды состояния HTTP

• 200 - Успешный запрос
• 201 - Созданный толчок
• 400 - Недопустимые параметры запроса
• 401 - Требуется аутентификация или недействительный токен
• 403 - Запрещено для текущего пользователя
• 404 - Ресурс не найден
• 422 - Ошибка валидации