Password Pusher API v2
BETAKompleksowa dokumentacja interfejsu API REST umożliwiająca integrację aplikacji Password Pusher z przepływami pracy, aplikacjami i narzędziami.
Powiadomienie o wersji beta: API v2 jest obecnie w wersji beta. Chociaż dołożyliśmy wszelkich starań, aby zapewnić stabilność, przed ostatecznym wydaniem mogą pojawić się przełomowe zmiany. Czekamy na Twoją opinię!
Przegląd
Interfejs API Password Pusher v2 zapewnia interfejs RESTful do tworzenia, pobierania i zarządzania bezpiecznymi wypychaniami haseł i żądaniami. Wszystkie punkty końcowe API zwracają odpowiedzi JSON i używają standardowych kodów stanu HTTP.
Uwierzytelnianie za pomocą tokena na okaziciela
Bezpieczny dostęp do API z uwierzytelnianiem opartym na tokenach
Odpowiedzi tylko w formacie JSON
Spójny format JSON we wszystkich punktach końcowych
Projektowanie RESTful
Intuicyjne punkty końcowe REST zgodne z najlepszymi praktykami
Pchnięcia i żądania
Obsługa wypychania jednokierunkowego i żądań dwukierunkowych
Generator hasła
Tworzenie haseł, fraz haseł i kodów PIN za pomocą metody POST /api/v2/generate
API v2 wykorzystuje uwierzytelnianie tokenem Bearer. Aby się uwierzytelnić, należy dołączyć token API w pliku Authorization nagłówek:
Authorization: Bearer YOUR_API_TOKEN
Pobieranie tokenu API
- Zaloguj się do swojego konta Password Pusher
- Przejdź do strony tokenów API
- Generowanie tokenu API
- Skopiuj token i użyj go w żądaniach API
Uwaga: Niektóre punkty końcowe (takie jak pobieranie powiadomienia push lub żądania albo generowanie hasła) są dostępne anonimowo. Tworzenie żądań, dostęp do dzienników audytowych oraz zarządzanie zbiorami wymagają uwierzytelnienia. Jeśli obowiązują zasady dotyczące zalogowanego obszaru roboczego, należy dołączyć token typu „Bearer” do generowanych żądań.
Wszystkie punkty końcowe API są poprzedzone przedrostkiem:
https://eu.pwpush.com/api/v2
Dostępność w wersji beta
API v2 jest obecnie w wersji beta i jest dostępne na stronie pwpush.com i samodzielnie hostowanej wersji Pro. Interfejs API zostanie dodany do edycji open-source po wyjściu z wersji beta.
W przypadku instancji hostowanych samodzielnie należy użyć własnej domeny. Podstawowy adres URL pokazany powyżej odzwierciedla bieżącego hosta, do którego uzyskujesz dostęp.
GET /api/v2/version
Zwraca bieżącą wersję API, szczegóły aplikacji i skrót funkcji opisujący, które funkcje są włączone w tej instancji.
Przykładowe żądanie
curl -X GET https://eu.pwpush.com/api/v2/version
Przykładowa odpowiedź
{
"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
}
}
}
}
Cechy Hash
anonymous_access - Czy dozwolone jest anonimowe korzystanie z API
api_token_authentication - Obsługa uwierzytelniania tokenem okaziciela
password_generator.enabled - Czy włączono generowanie haseł, fraz haseł i kodów PIN
password_generator.języki - Języki obsługiwanych list haseł
accounts.enabled - Czy lista przestrzeni roboczych jest dostępna pod adresem /api/v2/workspaces (starsza ścieżka /api/v2/accounts jest aliasem)?
pushes.enabled - Tworzenie powiadomień push i zarządzanie nimi za pośrednictwem interfejsu API
pushes.email_auto_dispatch - Czy ta instancja może wysyłać tajne linki w wiadomościach e-mail podczas tworzenia. Tylko wykrywanie funkcji — użyj parametru `notify_recipients` podczas tworzenia, aby zrezygnować z automatycznego wysyłania, jednocześnie podając `notify_emails_to` dla uwierzytelnionych odbiorców.
pushes.file_attachments.enabled - Załączniki plików w wiadomościach push
pushes.file_attachments.requires_authentication - Załączniki plików wymagają uwierzytelnienia
requests.enabled - Tworzenie żądań i zarządzanie nimi za pośrednictwem interfejsu API
requests.email_auto_dispatch - Czy ta instancja może wysyłać tajne linki w wiadomościach e-mail podczas tworzenia. Tylko wykrywanie funkcji — użyj parametru `notify_recipients` podczas tworzenia, aby zrezygnować z automatycznego wysyłania, jednocześnie podając `notify_emails_to` dla uwierzytelnionych odbiorców.
requests.file_attachments.enabled - Załączniki plików w odpowiedziach na żądania
requests.file_attachments.requires_authentication - Załączniki plików wymagają uwierzytelnienia
POST /api/v2/generate
Tworzy jedno lub więcej haseł, fraz haseł lub kodów PIN. Uwierzytelnianie jest opcjonalne. W przypadku anonimowych żądań stosowana jest polityka przestrzeni roboczej podstawowej (lub globalnej hostowanej samodzielnie). Aby skorzystać z polityki przestrzeni roboczej dla zalogowanych użytkowników, w tym w domenach niestandardowych, należy wysłać token typu „Bearer”.
Gdy konfiguracja generatora jest wyłączona na mocy zasad, nadpisania opcji są ignorowane, a uwzględniana jest wyłącznie liczba.
Jeśli generowanie hasła jest wyłączone, interfejs API zwraca kod błędu 403 Forbidden.
Liczba żądań jest ograniczona do 30 na minutę na adres IP lub uwierzytelnionego użytkownika.
Treść żądania (JSON)
Parametry należy przesłać w korzeniu obiektu JSON. W przypadku pominięcia pól stosowane są domyślne wartości określone w obowiązującej polityce.
| Parametr | Typ | Opis |
|---|---|---|
workspace_id
opcjonalny
|
string | Uwierzytelniony obszar roboczy, z którego ma zostać zastosowana polityka. Akceptuje również parametr `account_id`. Zwraca kod 401, jeśli wywołujący nie jest członkiem tego obszaru roboczego. |
type
opcjonalny
|
string | hasło, fraza hasłowa lub kod PIN |
count
opcjonalny
|
integer (1-10) | Liczba wartości do wygenerowania |
language
opcjonalny
|
string | Lista haseł: en, es, fr, de lub it |
word_count
opcjonalny
|
integer (3-10) | Liczba słów w frazie hasła |
separator
opcjonalny
|
string | Ciąg znaków wstawiony między słowami hasła |
capitalize
opcjonalny
|
boolean | Każde słowo hasła należy wpisać wielkimi literami |
number
opcjonalny
|
boolean | Dodaj cyfry do hasła |
symbol
opcjonalny
|
boolean | Dodaj symbol do hasła |
length
opcjonalny
|
integer | Długość hasła (4–128) lub długość kodu PIN (4–12) |
uppercase
opcjonalny
|
boolean | W hasłach należy używać wielkich liter |
lowercase
opcjonalny
|
boolean | W hasłach należy używać małych liter |
digits
opcjonalny
|
boolean | Hasła powinny zawierać cyfry |
symbols
opcjonalny
|
boolean | Używaj symboli w hasłach |
avoid_ambiguous
opcjonalny
|
boolean | Należy wykluczyć znaki, które mogą być mylnie zinterpretowane, takie jak 0, O, l i 1 |
min_digits
opcjonalny
|
integer | Minimalna liczba znaków w haśle |
min_symbols
opcjonalny
|
integer | Minimalna liczba znaków w haśle |
charset
opcjonalny
|
string | Ustawienie znaków: ASCII, alfabet łaciński, cyrylica lub alfabet grecki. Każda inna wartość jest traktowana jako niestandardowy zestaw znaków. |
Pola odpowiedzi
| Pole | Opis |
|---|---|
type |
hasło, fraza hasłowa lub kod PIN |
language |
Wartość dla haseł. Lista słów wykorzystana do wygenerowania wyniku. |
entropy_bits |
Szacowana wytrzymałość podana w odpowiedzi. Zobacz entropia jako miara siły hasła. |
results |
Tablica wygenerowanych ciągów znaków |
Przykładowe żądanie
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
}'
Przykładowa odpowiedź
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
Przykład hasła
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
}'
Przykład: Tworzenie i pobieranie push
# 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
Przykład: Utwórz żądanie i odpowiedz
# 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"
}
}'
Państwa wnioskujące
Interfejs API wykorzystuje standardowe kody stanu HTTP:
200 OK
Żądanie powiodło się
201 Created
Utworzony zasób
400 Bad Request
Nieprawidłowe parametry
422 Unprocessable Entity
Błędy walidacji lub nieprawidłowe dane żądania
401 Unauthorized
Wymagane uwierzytelnienie
403 Forbidden
Odmowa dostępu
404 Not Found
Nie znaleziono zasobu
Ograniczenia szybkości są wdrażane w celu ochrony interfejsu API przed nadużyciami i zapewnienia sprawiedliwego użytkowania dla wszystkich użytkowników. Limity szybkości są stosowane dla każdego adresu IP i różnią się w zależności od typu żądania i punktu końcowego.
Liczba żądań GET dotyczących dziennika audytowego jest ograniczona do 15 żądań na minutę na adres IP, przy czym limit szczytowy wynosi 5 żądań na 10 sekund oraz 30 żądań na minutę na uwierzytelnionego użytkownika lub token API.
Odpowiedzi dotyczące limitów stawek
Gdy żądanie przekroczy limit szybkości, interfejs API zwróci komunikat 429 Too Many Requests z kodem statusu Retry-After wskazujący, kiedy można ponowić żądanie.
Najlepsze praktyki
- Zaimplementuj wykładniczy backoff po otrzymaniu odpowiedzi 429
- Szanuj
Retry-Afterwartość nagłówka - Pamięć podręczna odpowiedzi, gdy jest to właściwe, aby zmniejszyć liczbę wywołań API
- Operacje wsadowe, jeśli to możliwe, zamiast wykonywania wielu pojedynczych żądań
- Monitorowanie wykorzystania API aplikacji w celu uniknięcia przekroczenia limitów
Uwaga: Limity stawek mają na celu zapobieganie nadużyciom przy jednoczesnym umożliwieniu legalnego użytkowania. Jeśli stale napotykasz limity stawek, rozważ optymalizację integracji lub skontaktowanie się z pomocą techniczną w celu omówienia przypadku użycia.
Ostatnia aktualizacja: November 09, 2026