Password Pusher API útgáfa 2
BETAÍtarleg skjölun um REST API til að samþætta Password Pusher í vinnuflæði, forrit og verkfæri.
Tilkynning um beta-próf: API útgáfa 2 er nú í beta-útgáfu. Þó að við höfum gert allt sem í okkar valdi stendur til að tryggja stöðugleika, gætu orðið einhverjar breytingar áður en lokaútgáfan kemur út. Við tökum vel á móti ábendingum þínum!
Yfirlit
Password Pusher API útgáfa 2 býður upp á RESTful viðmót til að búa til, sækja og stjórna öruggum lykilorðssendingum og beiðnum. Allir API endapunktar skila JSON svörum og nota staðlaða HTTP stöðukóða.
Auðkenning handhafaauðkennis
Öruggur aðgangur að API með auðkenningu sem byggir á táknum
Svör eingöngu í JSON
Samræmt JSON snið á öllum endapunktum
RESTful hönnun
Innsæisríkir REST endapunktar sem fylgja bestu starfsvenjum
Tilvísanir og beiðnir
Stuðningur við einhliða sendingar og tvíhliða beiðnir
Lykilorðsframleiðandi
Búa til lykilorð, lykilorð og PIN-númer í gegnum POST /api/v2/generate
API útgáfa 2 notar auðkenningu með Bearer-tákni. Til að auðkenna þig skaltu setja API-táknið þitt inn í Authorization fyrirsögn:
Authorization: Bearer YOUR_API_TOKEN
Að fá API-táknið þitt
- Skráðu þig inn á lykilorðsþjónunarreikninginn þinn
- Farðu á síðuna þína fyrir API-tákn
- Búa til API-tákn
- Afritaðu táknið og notaðu það í API-beiðnum þínum
Athugið: Hægt er að nálgast suma endapunkta (eins og að sækja tilkynningar eða beiðnir eða búa til lykilorð) nafnlaust. Að búa til beiðnir, fá aðgang að endurskoðunarskrám og stjórna söfnum krefjast auðkenningar. Hafðu Bearer-tákn með við gerð beiðna þegar þú þarft á stefnu um innskráða vinnusvæðinu að halda.
Allir API-endapunktar eru með forskeytinu:
https://eu.pwpush.com/api/v2
Tiltækileiki í beta-prófi
API útgáfa 2 er nú í beta-prófunarferli og er fáanleg á pwpush.com og sjálfhýstar Pro útgáfur. API-ið verður bætt við opna hugbúnaðarútgáfuna eftir að hún lýkur beta-útgáfu.
Fyrir sjálfhýst tilvik skaltu nota þitt eigið lén. Grunnslóðin sem sýnd er hér að ofan endurspeglar núverandi hýsingaraðila sem þú ert að nota.
GET /api/v2/version
Skilar núverandi API útgáfu, upplýsingum um forritið og eiginleikakvittun sem lýsir hvaða eiginleikar eru virkir í þessu tilviki.
Dæmi um beiðni
curl -X GET https://eu.pwpush.com/api/v2/version
Dæmi um 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
}
}
}
}Eiginleikar Hash
nafnlaus_aðgangur - Hvort nafnlaus notkun API sé leyfð
api_token_auðkenning - Stuðningur við auðkenningu handhafa
lykilorðsframleiðandi.virkjaður - Hvort lykilorð, lykilorð og PIN-númer séu virkjuð
lykilorðsframleiðandi.tungumál - Studd lykilorðalistamál
reikningar.virkjaðir - Hvort listi yfir vinnusvæði sé tiltækur á /api/v2/workspaces (eldri slóðin /api/v2/accounts er dulnefni)
ýtir.virkjað - Stofnun og stjórnun ýtinga í gegnum API
ýtir.email_auto_dispatch - Hvort þetta tilvik geti sent leynileg tengla með tölvupósti við „create“. Aðeins eiginleikagreining — notify_recipients create breytuna til að afþakka sjálfvirka sendingu en samt sem áður gefa upp notify_emails_to fyrir staðfesta viðtakendur.
ýtir.skrá_viðhengi.virkt - Skráarviðhengi í tilkynningum
ýtir.skrá_viðhengi.krefst_auðkenningar - Skráarviðhengi krefjast auðkenningar
beiðnir.virkjaðar - Beiðnagerð og stjórnun í gegnum API
beiðnir.tölvupóstur_sjálfvirk_sending - Hvort þetta tilvik geti sent leynileg tengla með tölvupósti við „create“. Aðeins eiginleikagreining — notify_recipients create breytuna til að afþakka sjálfvirka sendingu en samt sem áður gefa upp notify_emails_to fyrir staðfesta viðtakendur.
beiðnir.skráar_viðhengi.virkjað - Skráarviðhengi við beiðni um svör
beiðnir.skráar_viðhengi.krefst_auðkenningar - Skráarviðhengi krefjast auðkenningar
POST /api/v2/generate
Býr til eitt eða fleiri lykilorð, lykilorð eða PIN-númer. Auðkenning er valfrjáls. Nafnlausar beiðnir nota kjarna vinnusvæðisstefnuna (eða sjálfhýsta alþjóðlega stefnu). Senda Bearer-tákn til að nota innskráningarvinnusvæðisstefnuna, þar á meðal á sérsniðnum lénum.
Þegar stilling rafalls er óvirk samkvæmt stefnu eru valkostahnekkingar hunsaðar og aðeins talning er virt.
Ef lykilorðsmyndun er óvirk skilar API-ið 403 Forbidden.
Myndun er takmörkuð við 30 beiðnir á mínútu fyrir hverja IP-tölu eða staðfestan notanda.
Beiðnitexti (JSON)
Senda breytur í rót JSON-hlutarins. Slepptir reitir falla aftur í sjálfgefnar gildandi stefnur.
| Færibreyta | Tegund | Lýsing |
|---|---|---|
workspace_id
valfrjálst
|
string | Sannvottað vinnusvæði til að beita stefnu frá. Tekur einnig við account_id. Skilar 401 ef sá sem hringir er ekki meðlimur þess vinnusvæðis. |
type
valfrjálst
|
string | lykilorð, lykilorð eða PIN-númer |
count
valfrjálst
|
integer (1-10) | Fjöldi gilda sem á að búa til |
language
valfrjálst
|
string | Orðalisti með lykilorðum: en, es, fr, de eða it |
word_count
valfrjálst
|
integer (3-10) | Fjöldi orða í lykilorði |
separator
valfrjálst
|
string | Strengur settur inn á milli lykilorða |
capitalize
valfrjálst
|
boolean | Skrifaðu hvert orð í lykilorði með hástöfum |
number
valfrjálst
|
boolean | Bæta tölustöfum við lykilorð |
symbol
valfrjálst
|
boolean | Bæta tákni við lykilorð |
length
valfrjálst
|
integer | Lengd lykilorðs (4–128) eða lengd PIN-númers (4–12) |
uppercase
valfrjálst
|
boolean | Hafa hástafi í lykilorðum |
lowercase
valfrjálst
|
boolean | Hafa lágstafi í lykilorðum |
digits
valfrjálst
|
boolean | Hafa tölustafi í lykilorðum |
symbols
valfrjálst
|
boolean | Hafa tákn í lykilorðum |
avoid_ambiguous
valfrjálst
|
boolean | Útiloka tvíræða stafi eins og 0, O, l og 1 |
min_digits
valfrjálst
|
integer | Lágmarksfjöldi stafa í lykilorði |
min_symbols
valfrjálst
|
integer | Lágmarksfjöldi tákna í lykilorði |
charset
valfrjálst
|
string | Forstilltir stafir: ascii, latneskt, kýrillískt eða grískt. Öll önnur gildi eru meðhöndluð sem sérsniðið stafagrunnur. |
Svarsvið
| Akur | Lýsing |
|---|---|
type |
lykilorð, lykilorð eða PIN-númer |
language |
Til staðar fyrir lykilorð. Orðalistinn sem notaður var til að búa til niðurstöðuna. |
entropy_bits |
Áætlaður styrkur sem birtist í svarinu. Sjá Óreiða sem mælikvarði á styrk lykilorðs. |
results |
Fylki af mynduðum strengjum |
Dæmi um beiðni
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
}'Dæmi um svar
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Dæmi um lykilorð
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
}'Dæmi: Búa til og sækja tilkynningu
# 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/fkwjfvhall92Dæmi: Búa til beiðni og 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"
}
}'Beiðniríki
API-ið notar staðlaða HTTP stöðukóða:
200 OK
Beiðni tókst
201 Created
Auðlind búin til
400 Bad Request
Ógildar breytur
422 Unprocessable Entity
Staðfestingarvillur eða ógild beiðnigögn
401 Unauthorized
Auðkenning krafist
403 Forbidden
Aðgangur hafnaður
404 Not Found
Auðlind fannst ekki
Hraðatakmarkanir eru innleiddar til að vernda API-ið gegn misnotkun og tryggja sanngjarna notkun fyrir alla notendur. Hraðatakmarkanir eru notaðar fyrir hverja IP-tölu og eru mismunandi eftir tegund beiðni og endapunkti.
GET beiðnir úr endurskoðunarskrá eru takmarkaðar við 15 beiðnir á mínútu á IP-tölu, með hámarksfjölda beiðnir upp á 5 beiðnir á 10 sekúndum og 30 beiðnir á mínútu á hvern staðfestan notanda eða API-tákn.
Svör við hraðamörkum
Þegar beiðni fer yfir hraðamörkin skilar API-forritið 429 Too Many Requests stöðukóði með a Retry-After Haus sem gefur til kynna hvenær þú getur reynt beiðnina aftur.
Bestu starfsvenjur
- Innleiða veldisbundið bakslag þegar þú færð 429 svar
- Virðið
Retry-Aftergildi fyrirsagnar - Skyndiminnisvarnir þegar við á til að draga úr API-köllum
- Hópaaðgerðir þegar mögulegt er í stað þess að gera margar einstakar beiðnir
- Fylgstu með notkun API forritsins til að forðast að ná takmörkunum
Athugið: Takmörkun á hraða er hönnuð til að koma í veg fyrir misnotkun en um leið leyfa lögmæta notkun. Ef þú lendir stöðugt í takmörkunum á hraða skaltu íhuga að fínstilla samþættinguna þína eða hafa samband við þjónustuver til að ræða notkunartilvik þitt.
Síðast uppfært: October 23, 2026