Password Pusher API v2
BETAOmfattende REST API-dokumentation til integration af Password Pusher i dine arbejdsgange, applikationer og værktøjer.
Beta-meddelelse: API v2 er i øjeblikket i beta. Vi har gjort alt for at sikre stabilitet, men der kan forekomme ændringer inden den endelige udgivelse. Vi glæder os over din feedback!
Oversigt
Password Pusher API v2 giver en RESTful-grænseflade til at oprette, hente og administrere sikre password-pushes og -anmodninger. Alle API-slutpunkter returnerer JSON-svar og bruger standard HTTP-statuskoder.
Bærer-token-godkendelse
Sikker API-adgang med tokenbaseret autentificering
Kun JSON-svar
Ensartet JSON-format på tværs af alle slutpunkter
RESTful design
Intuitive REST-slutpunkter, der følger bedste praksis
Skub og anmodninger
Understøttelse af envejspushes og tovejsforespørgsler
Password Generator
Opret adgangskoder, adgangssætninger og PIN-koder via POST /api/v2/generate
API v2 bruger Bearer-token-godkendelse. For at godkende skal du inkludere dit API-token i Authorization overskrift:
Authorization: Bearer YOUR_API_TOKEN
Få dit API-token
- Log ind på din Password Pusher-konto
- Naviger til din API-tokens-side
- Generer et API-token
- Kopier tokenet, og brug det i dine API-anmodninger
Bemærk: Visse funktioner (f.eks. hentning af en push-besked eller en anmodning eller generering af en adgangskode) kan benyttes anonymt. Oprettelse af anmodninger, adgang til revisionslogfiler og administration af samlinger kræver godkendelse. Medtag et Bearer-token i de anmodninger, du genererer, når du skal overholde politikken for det indloggede arbejdsområde.
Alle API-slutpunkter har foranstillet præfiks:
https://eu.pwpush.com/api/v2
Tilgængelighed i beta
API v2 er i øjeblikket i beta og er tilgængelig på pwpush.com og selvhostede Pro-udgaver. API'en vil blive tilføjet til open source-udgaven, når den har forladt betaversionen.
For selvhostede instanser skal du bruge dit eget domæne. Den grundlæggende URL, der vises ovenfor, afspejler den aktuelle host, du har adgang til.
GET /api/v2/version
Returnerer den aktuelle API-version, applikationsoplysninger og en hash med funktioner, der beskriver, hvilke funktioner der er aktiveret i denne instans.
Eksempel på anmodning
curl -X GET https://eu.pwpush.com/api/v2/version
Eksempel 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_adgang - Om anonym API-brug er tilladt
api_token_autentificering - Støtte til autentificering med bærertoken
password_generator.enabled - Om generering af adgangskode, adgangssætning og PIN-kode er aktiveret
password_generator.sprog - Sprog, der understøttes i ordlisten for adgangskoder
konti.aktiveret - Om listen over arbejdsområder er tilgængelig på /api/v2/workspaces (den gamle sti /api/v2/accounts er et alias)
pushes.enabled - Oprettelse og styring af push via API
pushes.email_auto_dispatch - Om denne instans kan sende hemmelige links via e-mail ved oprettelse. Kun til funktionsdetektering — brug parameteren `notify_recipients` ved oprettelse for at fravælge automatisk udsendelse, samtidig med at du stadig angiver `notify_emails_to` for godkendte modtagere.
pushes.file_attachments.enabled - Vedhæftede filer på pushes
pushes.file_attachments.requires_authentication - Vedhæftede filer kræver godkendelse
anmodninger.aktiveret - Oprettelse og administration af anmodninger via API
requests.email_auto_dispatch - Om denne instans kan sende hemmelige links via e-mail ved oprettelse. Kun til funktionsdetektering — brug parameteren `notify_recipients` ved oprettelse for at fravælge automatisk udsendelse, samtidig med at du stadig angiver `notify_emails_to` for godkendte modtagere.
requests.file_attachments.enabled - Vedhæftede filer til svar på anmodninger
requests.file_attachments.requires_authentication - Vedhæftede filer kræver godkendelse
POST /api/v2/generate
Opretter en eller flere adgangskoder, adgangssætninger eller PIN-koder. Godkendelse er valgfri. Anonyme anmodninger bruger politikken for kernearbejdsområdet (eller den selvhostede globale politik). Send et Bearer-token for at anvende politikken for det indloggede arbejdsområde, herunder på brugerdefinerede domæner.
Når generatorkonfigurationen er deaktiveret via en politik, ignoreres overstyringer af indstillinger, og kun antallet tages i betragtning.
Hvis generering af adgangskoder er deaktiveret, returnerer API’et fejlkoden 403 Forbidden.
Genereringen er begrænset til 30 anmodninger pr. minut pr. IP-adresse eller godkendt bruger.
Anmodningskrop (JSON)
Send parametrene i roden af JSON-objektet. Udeladte felter indstilles til de gældende standardværdier i politikken.
| Parameter | Type | Beskrivelse |
|---|---|---|
workspace_id
valgfri
|
string | Et godkendt arbejdsområde, hvorfra politikken skal anvendes. Accepterer også account_id. Returnerer 401, hvis den, der kalder funktionen, ikke er medlem af det pågældende arbejdsområde. |
type
valgfri
|
string | adgangskode, adgangssætning eller PIN-kode |
count
valgfri
|
integer (1-10) | Antal værdier, der skal genereres |
language
valgfri
|
string | Liste over adgangskoder: en, es, fr, de eller it |
word_count
valgfri
|
integer (3-10) | Antal ord i en adgangskode |
separator
valgfri
|
string | Streng indsat mellem ordene i adgangskoden |
capitalize
valgfri
|
boolean | Skriv hvert ord i adgangskoden med stort begyndelsesbogstav |
number
valgfri
|
boolean | Tilføj cifre til en adgangskode |
symbol
valgfri
|
boolean | Føj et symbol til en adgangskode |
length
valgfri
|
integer | Adgangskodelængde (4–128) eller PIN-kodelængde (4–12) |
uppercase
valgfri
|
boolean | Brug store bogstaver i adgangskoder |
lowercase
valgfri
|
boolean | Brug små bogstaver i adgangskoder |
digits
valgfri
|
boolean | Brug tal i adgangskoder |
symbols
valgfri
|
boolean | Brug symboler i adgangskoder |
avoid_ambiguous
valgfri
|
boolean | Udelad tegn, der kan misforstås, såsom 0, O, l og 1 |
min_digits
valgfri
|
integer | Mindste antal cifre i en adgangskode |
min_symbols
valgfri
|
integer | Minimumsantal tegn i en adgangskode |
charset
valgfri
|
string | Forudindstillet tegnsæt: ASCII, latin, kyrillisk eller græsk. Enhver anden værdi behandles som en brugerdefineret tegnmængde. |
Svarfelter
| Felt | Beskrivelse |
|---|---|
type |
adgangskode, adgangssætning eller PIN-kode |
language |
Indtast adgangskoder. Den ordliste, der blev brugt til at generere resultatet. |
entropy_bits |
Den anslåede styrke vises i svaret. Se entropi som et mål for adgangskodens styrke. |
results |
En række genererede strenge |
Eksempel på anmodning
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
}'
Eksempel på svar
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
Eksempel på adgangskode
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
}'
Eksempel: Opret og hent et 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
Eksempel: Opret en anmodning og svar
# 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"
}
}'
Anmodning om stater
API'en bruger standard HTTP-statuskoder:
200 OK
Anmodning lykkedes
201 Created
Ressource oprettet
400 Bad Request
Ugyldige parametre
422 Unprocessable Entity
Valideringsfejl eller ugyldige forespørgselsdata
401 Unauthorized
Godkendelse påkrævet
403 Forbidden
Adgang nægtet
404 Not Found
Ressource ikke fundet
Hastighedsbegrænsning er implementeret for at beskytte API'en mod misbrug og sikre fair brug for alle brugere. Hastighedsgrænser anvendes pr. IP-adresse og varierer afhængigt af typen af anmodning og slutpunkt.
GET-anmodninger til revisionsloggen er begrænset til 15 anmodninger pr. minut pr. IP-adresse, med en spidsbelastningsgrænse på 5 anmodninger pr. 10 sekunder, samt 30 anmodninger pr. minut pr. godkendt bruger eller API-token.
Svar på hastighedsgrænser
Når en anmodning overskrider hastighedsgrænsen, returnerer API'en en 429 Too Many Requests statuskode med en Retry-After header, der angiver, hvornår du kan prøve igen.
Bedste praksis
- Implementer eksponentiel backoff, når du modtager et 429-svar
- Respekter den
Retry-Afterheader-værdi - Cache svar, når det er relevant, for at reducere API-kald
- Batch-operationer, når det er muligt, i stedet for at lave mange individuelle anmodninger
- Overvåg din applikations API-brug for at undgå at ramme grænser
Bemærk: Hastighedsgrænser er designet til at forhindre misbrug og samtidig tillade legitim brug. Hvis du konsekvent støder på hastighedsgrænser, bør du overveje at optimere din integration eller kontakte support for at diskutere din brugssituation.
Sidst opdateret: November 09, 2026