Преглед

Password Pusher API v2 пружа RESTful интерфејс за креирање, преузимање и управљање безбедним слањем лозинки и захтевима. Све крајње тачке API-ја враћају JSON одговоре и користе стандардне HTTP статусне кодове.

Аутентификација носиоца токена

Безбедан API приступ са аутентификацијом заснованом на токенима

Само JSON одговори

Доследан JSON формат на свим крајњим тачкама

RESTful дизајн

Интуитивне REST крајње тачке које прате најбоље праксе

Захтеви и поруке

Подршка за једносмерне и двосмерне захтеве

Пассворд Генератор

Креирајте лозинке, приступне фразе и ПИН-ове путем POST /api/v2/generate

GET /api/v2/version

Враћа тренутну верзију API-ја, детаље апликације и хеш функција који описује које су могућности омогућене на овој инстанци.

Пример захтева

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

Пример одговора

{
  "application_version": "2.1.0",
  "api_version": "2.1",
  "edition": "commercial",
  "features": {
    "anonymous_access": true,
    "api_token_authentication": true,
    "password_generator": {
      "enabled": true,
      "languages": ["de", "en", "es", "fr", "it"]
    },
    "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_токен_аутентификација - Подршка за аутентификацију токена носиоца

генератор_парола.омогућен - Да ли је омогућено генерисање лозинке, приступне фразе и ПИН-а

генератор_парола.језици - Подржани језици листе речи за лозинке

налози.омогућени - Да ли је листа радних простора доступна на /api/v2/workspaces (стара путања /api/v2/accounts је псеудоним)

pushes.enabled - Креирање и управљање порукама путем API-ја

pushes.email_auto_dispatch - Да ли ова инстанца може да шаље тајне линкове имејлом приликом креирања. Само детекција функција — користите параметар create notify_recipients да бисте искључили аутоматско слање, а да и даље достављате notify_emails_to за аутентификоване примаоце.

pushs.file_attachments.enabled - Прилози датотека приликом слања

pushs.file_attachments.requires_authentication - Прилози датотека захтевају аутентификацију

захтеви.омогућено - Креирање и управљање захтевима путем API-ја

захтеви.е-пошта_аутоматско_слање - Да ли ова инстанца може да шаље тајне линкове имејлом приликом креирања. Само детекција функција — користите параметар create notify_recipients да бисте искључили аутоматско слање, а да и даље достављате notify_emails_to за аутентификоване примаоце.

requests.file_attachments.enabled - Прилози у датотекама уз одговоре на захтев

захтеви.прилози_файлова.захтева_аутентификацију - Прилози датотека захтевају аутентификацију

POST /api/v2/generate

Креира једну или више лозинки, приступних фраза или ПИН-ова. Аутентификација је опционална. Анонимни захтеви користе политику основног радног простора (или самостално хостованог глобалног простора). Пошаљите токен носиоца да бисте користили политику радног простора пријављеног корисника, укључујући и прилагођене домене.

Када је конфигурација генератора онемогућена политиком, замене опција се игноришу и поштује се само бројање.

Ако је генерисање лозинки онемогућено, API враћа грешку 403 „Забрањено“.

Генерисање је ограничено на 30 захтева у минути по IP адреси или аутентификованом кориснику.

Тело захтева (JSON)

Параметре шаљите у корен JSON објекта. Изостављена поља се враћају на подразумеване вредности политике.

Параметар	Tip	Опис
`workspace_id` опционо	string	Аутентификовани радни простор за примену смерница. Такође прихвата account_id. Враћа 401 ако позивалац није члан тог радног простора.
`type` опционо	string	лозинка, приступна фраза или ПИН
`count` опционо	integer (1-10)	Број вредности за генерисање
`language` опционо	string	Листа речи за лозинку: en, es, fr, de или it
`word_count` опционо	integer (3-10)	Број речи у лозинки
`separator` опционо	string	Низ уметнут између речи лозинке
`capitalize` опционо	boolean	Почните сваку реч лозинке великим словом
`number` опционо	boolean	Додајте цифре лозинки
`symbol` опционо	boolean	Додајте симбол лозинки
`length` опционо	integer	Дужина лозинке (4–128) или дужина ПИН-а (4–12)
`uppercase` опционо	boolean	Укључите велика слова у лозинке
`lowercase` опционо	boolean	Укључите мала слова у лозинке
`digits` опционо	boolean	Укључите цифре у лозинке
`symbols` опционо	boolean	Укључите симболе у лозинке
`avoid_ambiguous` опционо	boolean	Искључите двосмислене знакове као што су 0, O, l и 1
`min_digits` опционо	integer	Минималан број цифара у лозинки
`min_symbols` опционо	integer	Минималан број симбола у лозинки
`charset` опционо	string	Унапред подешена слова: ascii, латиница, ћирилица или грчки. Било која друга вредност се третира као прилагођени скуп знакова.

Поља за одговор

Поље	Опис
`type`	лозинка, приступна фраза или ПИН
`language`	Присутно за лозинке. Листа речи која се користи за генерисање резултата.
`entropy_bits`	Процењена јачина враћена у одговору. Види ентропија као мера јачине лозинке.
`results`	Низ генерисаних стрингова

Пример захтева

curl -X POST https://eu.pwpush.com/api/v2/generate \
  -H "Content-Type: application/json" \
  -d '{
    "type": "passphrase",
    "language": "en",
    "word_count": 4,
    "count": 2
  }'

Пример одговора

{
  "type": "passphrase",
  "language": "en",
  "entropy_bits": 51.7,
  "results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}

Пример лозинке

curl -X POST https://eu.pwpush.com/api/v2/generate \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "password",
    "length": 20,
    "symbols": true
  }'

Пример: Креирање и преузимање поруке

# Create a push
curl -X POST https://eu.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://eu.pwpush.com/api/v2/pushes/fkwjfvhall92

Пример: Креирајте захтев и одговорите

# Create a request
curl -X POST https://eu.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://eu.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 адреси и варирају у зависности од типа захтева и крајње тачке.

GET захтеви за евиденцију ревизије су ограничени на 15 захтева у минути по IP адреси, са ограничењем од 5 захтева на 10 секунди и 30 захтева у минути по аутентификованом кориснику или API токену.

Одговори на ограничење брзине

Када захтев пређе ограничење брзине, API враћа 429 Too Many Requests статусни код са Retry-After заглавље које показује када можете поново покушати захтев.

Најбоље праксе

Имплементирајте експоненцијално одлагање када добијете одговор 429
Поштујте Retry-After вредност заглавља
Кеширајте одговоре када је то потребно да бисте смањили API позиве
Групне операције када је то могуће уместо подношења много појединачних захтева
Пратите коришћење API-ја ваше апликације како бисте избегли прекорачење ограничења

Напомена: Ограничења брзине су осмишљена да спрече злоупотребу, а истовремено омогуће легитимну употребу. Ако стално наилазите на ограничења брзине, размислите о оптимизацији интеграције или контактирању подршке да бисте разговарали о свом случају употребе.

Password Pusher API верзије 2

Преглед

Аутентификација носиоца токена

Само JSON одговори

RESTful дизајн

Захтеви и поруке

Пассворд Генератор

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

Добијање вашег API токена

Основни URL

Доступност бета верзије

Верзија

GET /api/v2/version

Пример захтева

Пример одговора

Хеш карактеристика

Генериши

Тело захтева (JSON)

Поља за одговор

Пример захтева

Пример одговора

Пример лозинке

Комплетни примери

Пример: Креирање и преузимање поруке

Пример: Креирајте захтев и одговорите

Захтевне државе

Обрада грешака

Ограничења брзине

Одговори на ограничење брзине

Најбоље праксе