Password Pusher API v2
BETAOmfattande REST API-dokumentation för att integrera Password Pusher i dina arbetsflöden, applikationer och verktyg.
Beta Meddelande: API v2 är för närvarande i betaversion. Även om vi har gjort allt för att säkerställa stabilitet kan det förekomma ändringar innan den slutliga utgåvan. Vi välkomnar din feedback!
Översikt
Password Pusher API v2 tillhandahåller ett RESTful-gränssnitt för att skapa, hämta och hantera säkra lösenordspushar och -förfrågningar. Alla API-slutpunkter returnerar JSON-svar och använder standard HTTP-statuskoder.
Autentisering med bärare och token
Säker API-åtkomst med tokenbaserad autentisering
Endast JSON-svar
Konsekvent JSON-format för alla slutpunkter
RESTful design
Intuitiva REST-slutpunkter enligt bästa praxis
Påtryckningar och förfrågningar
Stöd för envägspushar och tvåvägsförfrågningar
Lösenordsgenerator
Skapa lösenord, lösenfraser och PIN-koder via POST /api/v2/generate
API v2 använder autentisering med Bearer-token. För att autentisera inkluderar du din API-token i Authorization header:
Authorization: Bearer YOUR_API_TOKEN
Hämta din API-token
- Logga in på ditt Password Pusher-konto
- Navigera till din API-tokens-sida
- Generera en API-token
- Kopiera token och använd den i dina API-begäranden
Obs! Vissa funktioner (som att hämta en push-meddelande eller en begäran, eller att generera ett lösenord) kan användas anonymt. Att skapa begäranden, få åtkomst till granskningsloggar och hantera samlingar kräver autentisering. Bifoga ett Bearer-token när du skapar begäranden om du behöver följa policyn för inloggade arbetsytor.
Alla API-slutpunkter har prefixet :
https://eu.pwpush.com/api/v2
Tillgänglighet för betaversion
API v2 är för närvarande i betaversion och finns tillgängligt på pwpush.com och Pro-utgåvorna med egen värd. API:et kommer att läggas till i open source-utgåvan efter att den har lämnat betaversionen.
För instanser med egen host använder du din egen domän. Bas-URL:en som visas ovan återspeglar den aktuella värden som du har åtkomst till.
GET /api/v2/version
Returnerar den aktuella API-versionen, programdetaljer och en hash för funktioner som beskriver vilka funktioner som är aktiverade i den här instansen.
Exempel på begäran
curl -X GET https://eu.pwpush.com/api/v2/version
Exempel på svar
{
"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
}
}
}
}Funktioner Hash
anonym_access - Om anonym API-användning är tillåten
api_token_autentisering - Stöd för autentisering med Bearer-token
password_generator.enabled - Om generering av lösenord, lösenfraser och PIN-koder är aktiverad
password_generator.språk - Språk som stöds i ordlistan för lösenordsfraser
konton.aktiverad - Om listan över arbetsytor är tillgänglig på /api/v2/workspaces (den gamla sökvägen /api/v2/accounts är ett alias)
pushes.aktiverad - Skapande och hantering av push via API
pushes.email_auto_dispatch - Om denna instans kan skicka hemliga länkar via e-post vid skapandet. Endast funktionsdetektering — använd parametern `notify_recipients` vid skapandet för att avaktivera automatisk utskick, samtidigt som du fortfarande anger `notify_emails_to` för autentiserade mottagare.
pushes.file_attachments.aktiverad - Filbilagor vid utskick
pushes.file_attachments.kräver_autentisering - Filbilagor kräver autentisering
förfrågningar.aktiverad - Skapande och hantering av förfrågningar via API
förfrågningar.e-post_auto_dispatch - Om denna instans kan skicka hemliga länkar via e-post vid skapandet. Endast funktionsdetektering — använd parametern `notify_recipients` vid skapandet för att avaktivera automatisk utskick, samtidigt som du fortfarande anger `notify_emails_to` för autentiserade mottagare.
förfrågningar.fil_bilagor.aktiverad - Filbilagor på begäran av svar
requests.file_attachments.requires_authentication - Filbilagor kräver autentisering
POST /api/v2/generate
Skapar ett eller flera lösenord, lösenfraser eller PIN-koder. Autentisering är valfritt. Anonyma förfrågningar använder policyn för kärnarbetsytan (eller den egenhostade globala arbetsytan). Skicka ett Bearer-token för att använda policyn för den inloggade arbetsytan, även på anpassade domäner.
När generatorkonfigurationen är inaktiverad enligt policyn ignoreras inställningar som åsidosätter den och endast antalet beaktas.
Om lösenordsgenereringen är inaktiverad returnerar API:et felkoden 403 Forbidden.
Genereringen är begränsad till 30 förfrågningar per minut per IP-adress eller autentiserad användare.
Huvuddel av begäran (JSON)
Skicka parametrarna i roten av JSON-objektet. Fält som utelämnas ersätts med de gällande standardvärdena i policyn.
| Parameter | Typ | Beskrivning |
|---|---|---|
workspace_id
frivillig
|
string | Autentiserad arbetsyta från vilken policyn ska tillämpas. Accepterar även account_id. Returnerar 401 om den som anropar inte är medlem i den arbetsytan. |
type
frivillig
|
string | lösenord, lösenfras eller PIN-kod |
count
frivillig
|
integer (1-10) | Antal värden som ska genereras |
language
frivillig
|
string | Lista över lösenordsfraser: en, es, fr, de, or it |
word_count
frivillig
|
integer (3-10) | Antal ord i en lösenfras |
separator
frivillig
|
string | Sträng som infogats mellan orden i lösenfrasen |
capitalize
frivillig
|
boolean | Skriv varje ord i lösenfrasen med versaler |
number
frivillig
|
boolean | Lägg till siffror till en lösenfras |
symbol
frivillig
|
boolean | Lägg till en symbol i en lösenfras |
length
frivillig
|
integer | Lösenordets längd (4–128) eller PIN-kodens längd (4–12) |
uppercase
frivillig
|
boolean | Använd versaler i lösenorden |
lowercase
frivillig
|
boolean | Använd gemener i lösenorden |
digits
frivillig
|
boolean | Använd siffror i lösenorden |
symbols
frivillig
|
boolean | Använd symboler i lösenorden |
avoid_ambiguous
frivillig
|
boolean | Uteslut tecken som kan misstolkas, till exempel 0, O, l och 1 |
min_digits
frivillig
|
integer | Minsta antal siffror i ett lösenord |
min_symbols
frivillig
|
integer | Minsta antal tecken i ett lösenord |
charset
frivillig
|
string | Bokstavsinställning: ascii, latin, kyrilliska eller grekiska. Alla andra värden behandlas som en anpassad teckenuppsättning. |
Svarsfält
| Fält | Beskrivning |
|---|---|
type |
lösenord, lösenfras eller PIN-kod |
language |
Värde för lösenordsfraser. Den ordlista som använts för att generera resultatet. |
entropy_bits |
Beräknad styrka returnerades i svaret. Se entropi som mått på lösenordets styrka. |
results |
En uppsättning genererade strängar |
Exempel på begäran
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
}'Exempel på svar
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Exempel på lösenord
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
}'Exempel: Skapa och hämta en 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/fkwjfvhall92Exempel: Skapa en förfrågan och svara
# 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"
}
}'Begäran stater
API:et använder standardiserade HTTP-statuskoder:
200 OK
Begäran godkändes
201 Created
Resurs skapad
400 Bad Request
Ogiltiga parametrar
422 Unprocessable Entity
Valideringsfel eller ogiltiga förfrågningsdata
401 Unauthorized
Autentisering krävs
403 Forbidden
Åtkomst nekad
404 Not Found
Resurs hittades inte
Hastighetsbegränsning implementeras för att skydda API:et från missbruk och säkerställa rättvis användning för alla användare. Hastighetsgränser tillämpas per IP-adress och varierar beroende på typ av begäran och slutpunkt.
GET-förfrågningar till revisionsloggen är begränsade till 15 förfrågningar per minut per IP-adress, med en toppgräns på 5 förfrågningar per 10 sekunder, samt 30 förfrågningar per minut per autentiserad användare eller API-token.
Svar på gränsvärde för hastighet
När en begäran överskrider hastighetsgränsen returnerar API:et ett 429 Too Many Requests statuskod med en Retry-After header som anger när du kan försöka igen med begäran.
Bästa metoder
- Implementera exponentiell backoff när du får ett 429-svar
- Respektera
Retry-Afterrubrikvärde - Cache-svar när så är lämpligt för att minska antalet API-anrop
- Batchoperationer när så är möjligt istället för att göra många enskilda förfrågningar
- Övervaka API-användningen i din applikation för att undvika att stöta på gränser
Obs! Hastighetsgränser är utformade för att förhindra missbruk samtidigt som de tillåter legitim användning. Om du konsekvent stöter på hastighetsbegränsningar bör du överväga att optimera din integration eller kontakta support för att diskutera ditt användningsfall.
Senast uppdaterad: October 17, 2026