Password Pusher API v2
BETAOmfattende REST API-dokumentasjon for integrering av Password Pusher i arbeidsflyter, applikasjoner og verktøy.
Beta-varsel: API v2 er for øyeblikket i betaversjon. Vi har gjort vårt ytterste for å sikre stabilitet, men det kan forekomme endringer før den endelige utgivelsen. Vi tar gjerne imot tilbakemeldinger!
Oversikt
Password Pusher API v2 tilbyr et RESTful-grensesnitt for å opprette, hente og administrere sikre passordpush og -forespørsler. Alle API-endepunkter returnerer JSON-svar og bruker standard HTTP-statuskoder.
Autentisering med bærertoken
Sikker API-tilgang med tokenbasert autentisering
Kun JSON-svar
Konsekvent JSON-format på tvers av alle endepunkter
RESTful design
Intuitive REST-sluttpunkter som følger beste praksis
Push og forespørsler
Støtte for enveis push og toveis forespørsler
Passordgenerator
Opprett passord, passfraser og PIN-koder via POST /api/v2/generate
API v2 bruker Bearer-token-autentisering. For å autentisere inkluderer du API-tokenet ditt i Authorization overskrift:
Authorization: Bearer YOUR_API_TOKEN
Få API-tokenet ditt
- Logg inn på Password Pusher-kontoen din
- Naviger til API-tokens-siden din
- Generer et API-token
- Kopier tokenet og bruk det i API-forespørsler
Merk: Noen endepunkter (for eksempel å hente en push-melding eller forespørsel, eller å generere et passord) kan brukes anonymt. Å opprette forespørsler, få tilgang til revisjonslogger og administrere samlinger krever autentisering. Legg ved et «Bearer»-token når du oppretter forespørsler der retningslinjene for det påloggede arbeidsområdet gjelder.
Alle API-endepunkter har prefikset :
https://eu.pwpush.com/api/v2
Tilgjengelighet i betaversjon
API v2 er for tiden i betaversjon og er tilgjengelig på pwpush.com og selvbetjente Pro-utgaver. API-et vil bli lagt til i åpen kildekode-utgaven etter at den har gått ut av betaversjonen.
For selv-hostede instanser bruker du ditt eget domene. Basis-URL-en som vises ovenfor, gjenspeiler den aktuelle hosten du har tilgang til.
GET /api/v2/version
Returnerer gjeldende API-versjon, applikasjonsdetaljer og en hash med funksjoner som beskriver hvilke funksjoner som er aktivert i denne instansen.
Eksempel på forespørsel
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
}
}
}
}Funksjoner Hash
anonym_tilgang - Om anonym API-bruk er tillatt
api_token_autentisering - Støtte for autentisering med bærertoken
password_generator.enabled - Om generering av passord, passfrase og PIN-kode er aktivert
password_generator.språk - Språk som støttes i ordlisten for passordfraser
accounts.enabled - Om arbeidsområdeoppføringen er tilgjengelig på /api/v2/workspaces (den gamle banen /api/v2/accounts er et alias)
pushes.enabled - Opprettelse og administrasjon av push via API
pushes.email_auto_dispatch - Om denne instansen kan sende hemmelige lenker via e-post ved opprettelse. Kun funksjonsdeteksjon — bruk opprettelsesparameteren `notify_recipients` for å velge bort automatisk utsendelse, samtidig som du fortsatt angir `notify_emails_to` for autentiserte mottakere.
pushes.file_attachments.enabled - Filvedlegg på push
pushes.file_attachments.requires_authentication - Filvedlegg krever autentisering
forespørsler.aktivert - Opprettelse og administrasjon av forespørsler via API
requests.email_auto_dispatch - Om denne instansen kan sende hemmelige lenker via e-post ved opprettelse. Kun funksjonsdeteksjon — bruk opprettelsesparameteren `notify_recipients` for å velge bort automatisk utsendelse, samtidig som du fortsatt angir `notify_emails_to` for autentiserte mottakere.
forespørsler.fil_vedlegg.aktivert - Filvedlegg på svar på forespørsler
requests.file_attachments.requires_authentication - Filvedlegg krever autentisering
POST /api/v2/generate
Oppretter ett eller flere passord, passfraser eller PIN-koder. Autentisering er valgfritt. Anonyme forespørsler bruker retningslinjen for kjernearbeidsområdet (eller det selvhostede globale arbeidsområdet). Send et «Bearer»-token for å bruke retningslinjen for det påloggede arbeidsområdet, også på tilpassede domener.
Når generatorkonfigurasjonen er deaktivert i henhold til retningslinjene, blir overstyringer av alternativer ignorert, og det er kun antallet som tas i betraktning.
Hvis passordgenerering er deaktivert, returnerer API-et feilkoden 403 Forbidden.
Genereringen er begrenset til 30 forespørsler per minutt per IP-adresse eller autentisert bruker.
Forespørselstekst (JSON)
Send parametrene i roten av JSON-objektet. Felter som utelates, erstattes av de gjeldende standardinnstillingene i policyen.
| Parameter | Type | Beskrivelse |
|---|---|---|
workspace_id
valgfri
|
string | Autentisert arbeidsområde som retningslinjene skal gjelde for. Aksepterer også account_id. Returnerer 401 hvis den som kaller ikke er medlem av dette arbeidsområdet. |
type
valgfri
|
string | passord, passfrase eller PIN-kode |
count
valgfri
|
integer (1-10) | Antall verdier som skal genereres |
language
valgfri
|
string | Liste over passordfraser: en, es, fr, de eller it |
word_count
valgfri
|
integer (3-10) | Antall ord i en passfrase |
separator
valgfri
|
string | Streng som er satt inn mellom ordene i passordfrasen |
capitalize
valgfri
|
boolean | Skriv hvert ord i passordfrasen med stor forbokstav |
number
valgfri
|
boolean | Legg til sifre i en passfrase |
symbol
valgfri
|
boolean | Legg til et symbol i passordfrasen |
length
valgfri
|
integer | Passordlengde (4–128) eller PIN-kode (4–12) |
uppercase
valgfri
|
boolean | Bruk store bokstaver i passordene |
lowercase
valgfri
|
boolean | Bruk små bokstaver i passordene |
digits
valgfri
|
boolean | Bruk tall i passordene |
symbols
valgfri
|
boolean | Bruk symboler i passordene |
avoid_ambiguous
valgfri
|
boolean | Utelat tegn som kan misforstås, for eksempel 0, O, l og 1 |
min_digits
valgfri
|
integer | Minimumsantall tegn i et passord |
min_symbols
valgfri
|
integer | Minimumsantall tegn i et passord |
charset
valgfri
|
string | Forhåndsinnstilt tegnsett: ASCII, latin, kyrillisk eller gresk. Alle andre verdier behandles som et egendefinert tegnsett. |
Svarfelt
| Felt | Beskrivelse |
|---|---|
type |
passord, passfrase eller PIN-kode |
language |
Presentasjon av passordfraser. Ordlisten som ble brukt til å generere resultatet. |
entropy_bits |
Anslått styrke vises i svaret. Se entropi som mål på passordstyrke. |
results |
Matrise med genererte strenger |
Eksempel på forespørsel
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å passord
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: Opprett og hent 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/fkwjfvhall92Eksempel: Opprett en forespørsel 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"
}
}'Forespørsel stater
API-et bruker standard HTTP-statuskoder:
200 OK
Forespørselen lyktes
201 Created
Opprettet ressurs
400 Bad Request
Ugyldige parametere
422 Unprocessable Entity
Valideringsfeil eller ugyldige forespørselsdata
401 Unauthorized
Autentisering kreves
403 Forbidden
Tilgang avslått
404 Not Found
Ressurs ikke funnet
Hastighetsbegrensning er implementert for å beskytte API-et mot misbruk og sikre rettferdig bruk for alle brukere. Hastighetsgrenser brukes per IP-adresse og varierer avhengig av type forespørsel og endepunkt.
GET-forespørsler til revisjonsloggen er begrenset til 15 forespørsler per minutt per IP-adresse, med en spissbelastningsgrense på 5 forespørsler per 10 sekunder, og 30 forespørsler per minutt per autentisert bruker eller API-token.
Svar på hastighetsbegrensning
Når en forespørsel overskrider hastighetsgrensen, returnerer API-et en 429 Too Many Requests statuskode med en Retry-After header som angir når du kan prøve forespørselen på nytt.
Beste praksis
- Implementere eksponentiell backoff når du mottar et 429-svar
- Respekter
Retry-Aftertopptekstverdi - Cache-svar når det er hensiktsmessig for å redusere API-anrop
- Batchoperasjoner når det er mulig, i stedet for mange individuelle forespørsler
- Overvåk API-bruken i applikasjonen din for å unngå å støte på grenser
Merk: Hastighetsgrenser er utformet for å forhindre misbruk, samtidig som legitim bruk tillates. Hvis du stadig støter på takstbegrensninger, bør du vurdere å optimalisere integrasjonen eller kontakte kundestøtte for å diskutere brukstilfellet ditt.
Sist oppdatert: October 22, 2026