Password Pusher API versió 2
BETADocumentació completa de l'API REST per integrar Password Pusher als vostres fluxos de treball, aplicacions i eines.
Avís beta: L'API v2 està actualment en versió beta. Tot i que hem fet tot el possible per garantir l'estabilitat, és possible que hi hagi canvis importants abans del llançament final. Agraïm els vostres comentaris!
Visió general
L'API v2 de Password Pusher proporciona una interfície RESTful per crear, recuperar i gestionar push i sol·licituds de contrasenyes segures. Tots els punts finals de l'API retornen respostes JSON i utilitzen codis d'estat HTTP estàndard.
Autenticació del testimoni del portador
Accés segur a l'API amb autenticació basada en tokens
Respostes només JSON
Format JSON coherent a tots els punts finals
Disseny RESTful
Punts finals REST intuïtius seguint les millors pràctiques
Empenyes i sol·licituds
Suport per a sol·licituds push unidireccionals i bidireccionals
Generador de contrasenyes
Crea contrasenyes, frases de contrasenya i PIN mitjançant POST /api/v2/generate
L'API v2 utilitza l'autenticació del testimoni de portador. Per autenticar-vos, incloeu el vostre testimoni d'API a Authorization capçalera:
Authorization: Bearer YOUR_API_TOKEN
Obtenint el vostre token d'API
- Inicia la sessió al teu compte de Password Pusher
- Navegueu a la pàgina de tokens de l'API
- Generar un token d'API
- Copieu el token i utilitzeu-lo a les vostres sol·licituds de l'API
Nota: Es pot accedir a alguns punts finals (com ara la recuperació d'una push o una sol·licitud, o la generació d'una contrasenya) de forma anònima. La creació de sol·licituds, l'accés als registres d'auditoria i la gestió de col·leccions requereixen autenticació. Incloeu un testimoni de portador a la generació de sol·licituds quan necessiteu la política d'espai de treball amb sessió iniciada.
Tots els punts finals de l'API tenen el prefix:
https://eu.pwpush.com/api/v2
Disponibilitat beta
L'API v2 està actualment en versió beta i està disponible a pwpush.com i edicions Pro autoallotjades. L'API s'afegirà a l'edició de codi obert després que surti de la versió beta.
Per a instàncies autoallotjades, feu servir el vostre propi domini. L'URL base que es mostra a dalt reflecteix l'amfitrió actual al qual esteu accedint.
GET /api/v2/version
Retorna la versió actual de l'API, els detalls de l'aplicació i un hash de funcions que descriu quines capacitats estan habilitades en aquesta instància.
Exemple de sol·licitud
curl -X GET https://eu.pwpush.com/api/v2/version
Exemple de resposta
{
"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
}
}
}
}Característiques Hash
accés_anònim - Si es permet l'ús anònim de l'API
autenticació_d'api_token - Suport d'autenticació de token de portador
generador_de_passwords.habilitat - Si la generació de contrasenyes, frases de contrasenya i PIN està habilitada
generador_de_passwords.idiomes - Idiomes compatibles amb la llista de paraules de contrasenya
comptes.habilitats - Si la llista d'espais de treball està disponible a /api/v2/workspaces (la ruta antiga /api/v2/accounts és un àlies)
pushes.habilitat - Creació i gestió de push mitjançant API
pushes.email_auto_dispatch - Si aquesta instància pot enviar enllaços secrets per correu electrònic en crear-los. Només detecció de funcions: utilitzeu el paràmetre notify_recipients create per desactivar l'enviament automàtic i, alhora, proporcionar notify_emails_to per als destinataris autenticats.
pushes.file_attachments.enabled - Fitxers adjunts a les trameses
pushes.file_attachments.requires_authentication - Els fitxers adjunts requereixen autenticació
sol·licituds.habilitades - Creació i gestió de sol·licituds mitjançant API
sol·licituds.enviament_automàtic_de_correu_electrònic - Si aquesta instància pot enviar enllaços secrets per correu electrònic en crear-los. Només detecció de funcions: utilitzeu el paràmetre notify_recipients create per desactivar l'enviament automàtic i, alhora, proporcionar notify_emails_to per als destinataris autenticats.
sol·licituds.adjunts_de_fitxer.habilitat - Fitxers adjunts a les respostes a sol·licituds
sol·licituds.adjunts_de_fitxer.requereix_autenticació - Els fitxers adjunts requereixen autenticació
POST /api/v2/generate
Crea una o més contrasenyes, frases de contrasenya o PIN. L'autenticació és opcional. Les sol·licituds anònimes utilitzen la política principal de l'espai de treball (o global autoallotjada). Envia un testimoni de portador per utilitzar la política de l'espai de treball amb sessió iniciada, fins i tot en dominis personalitzats.
Quan la configuració del generador està desactivada per política, les substitucions d'opcions s'ignoren i només es respecta el recompte.
Si la generació de contrasenyes està desactivada, l'API retorna un error 403 Prohibit.
La generació està limitada a 30 sol·licituds per minut per adreça IP o usuari autenticat.
Cos de la sol·licitud (JSON)
Envia els paràmetres a l'arrel de l'objecte JSON. Els camps omesos utilitzen els valors predeterminats de la política vigent.
| Paràmetre | Tipus | Descripció |
|---|---|---|
workspace_id
opcional
|
string | Espai de treball autenticat des del qual s'aplica la política. També accepta account_id. Retorna 401 si la persona que truca no és membre d'aquest espai de treball. |
type
opcional
|
string | contrasenya, frase de contrasenya o PIN |
count
opcional
|
integer (1-10) | Nombre de valors a generar |
language
opcional
|
string | Llista de paraules amb contrasenya: en, es, fr, de o it |
word_count
opcional
|
integer (3-10) | Nombre de paraules en una contrasenya |
separator
opcional
|
string | Cadena inserida entre paraules de contrasenya |
capitalize
opcional
|
boolean | Majúscula per a cada paraula de contrasenya |
number
opcional
|
boolean | Afegeix dígits a una contrasenya |
symbol
opcional
|
boolean | Afegeix un símbol a una contrasenya |
length
opcional
|
integer | Longitud de la contrasenya (4–128) o longitud del PIN (4–12) |
uppercase
opcional
|
boolean | Incloure majúscules a les contrasenyes |
lowercase
opcional
|
boolean | Incloure lletres minúscules a les contrasenyes |
digits
opcional
|
boolean | Incloure dígits a les contrasenyes |
symbols
opcional
|
boolean | Incloure símbols a les contrasenyes |
avoid_ambiguous
opcional
|
boolean | Exclou caràcters ambigus com ara 0, O, l i 1 |
min_digits
opcional
|
integer | Nombre mínim de dígits en una contrasenya |
min_symbols
opcional
|
integer | Nombre mínim de símbols en una contrasenya |
charset
opcional
|
string | Predefinició de lletres: ascii, llatí, ciríl·lic o grec. Qualsevol altre valor es tracta com un conjunt de caràcters personalitzat. |
Camps de resposta
| Camp | Descripció |
|---|---|
type |
contrasenya, frase de contrasenya o PIN |
language |
Present per a contrasenyes. La llista de paraules utilitzada per generar el resultat. |
entropy_bits |
Força estimada retornada a la resposta. Vegeu L'entropia com a mesura de la força de la contrasenya. |
results |
Matriu de cadenes generades |
Exemple de sol·licitud
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
}'Exemple de resposta
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Exemple de contrasenya
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
}'Exemple: Crear i recuperar una 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/fkwjfvhall92Exemple: Crea una sol·licitud i respon
# 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"
}
}'Estats sol·licitants
L'API utilitza codis d'estat HTTP estàndard:
200 OK
La sol·licitud s'ha completat correctament
201 Created
Recurs creat
400 Bad Request
Paràmetres no vàlids
422 Unprocessable Entity
Errors de validació o dades de sol·licitud no vàlides
401 Unauthorized
Cal autenticació
403 Forbidden
Accés denegat
404 Not Found
Recurs no trobat
La limitació de velocitat s'implementa per protegir l'API de l'abús i garantir un ús just per a tots els usuaris. Els límits de velocitat s'apliquen per adreça IP i varien segons el tipus de sol·licitud i el punt final.
Les sol·licituds GET del registre d'auditoria estan limitades a 15 sol·licituds per minut per IP, amb un límit de ràfegues de 5 sol·licituds cada 10 segons i 30 sol·licituds per minut per usuari autenticat o testimoni d'API.
Respostes al límit de velocitat
Quan una sol·licitud supera el límit de velocitat, l'API retorna un 429 Too Many Requests codi d'estat amb un Retry-After capçalera que indica quan podeu tornar a intentar la sol·licitud.
Millors pràctiques
- Implementa el backoff exponencial quan rebis una resposta 429
- Respectar el
Retry-Aftervalor de la capçalera - Emmagatzemar respostes a la memòria cau quan sigui necessari per reduir les crides a l'API
- Operacions per lots quan sigui possible en lloc de fer moltes sol·licituds individuals
- Superviseu l'ús de l'API de la vostra aplicació per evitar arribar als límits
Nota: Els límits de velocitat estan dissenyats per evitar l'abús i alhora permetre l'ús legítim. Si us trobeu amb límits de velocitat de manera consistent, considereu optimitzar la vostra integració o contactar amb el suport tècnic per discutir el vostre cas d'ús.
Darrera actualització: October 24, 2026