Password Pusher API fersiwn 2
BETADogfennaeth gynhwysfawr REST API ar gyfer integreiddio Password Pusher i'ch llifau gwaith, cymwysiadau ac offer.
Hysbysiad Beta: Mae API v2 ar hyn o bryd mewn beta. Er ein bod wedi gwneud pob ymdrech i sicrhau sefydlogrwydd, efallai y bydd newidiadau torfol cyn y datganiad terfynol. Rydym yn croesawu eich adborth!
Trosolwg
Mae API Gwthio Cyfrinair v2 yn darparu rhyngwyneb RESTful ar gyfer creu, adfer a rheoli gwthio a cheisiadau cyfrinair diogel. Mae pob pwynt terfyn API yn dychwelyd ymatebion JSON ac yn defnyddio codau statws HTTP safonol.
Dilysu Tocyn Cludwr
Mynediad API diogel gyda dilysu seiliedig ar docynnau
Ymatebion JSON yn Unig
Fformat JSON cyson ar draws pob pwynt terfyn
Dylunio RESTful
Pwyntiau terfyn REST greddfol yn dilyn arferion gorau
Gwthiadau a Cheisiadau
Cefnogaeth ar gyfer gwthio unffordd a cheisiadau dwyffordd
Cynhyrchydd Cyfrinair
Creu cyfrineiriau, ymadroddion cyfrin, a PINau drwy POST /api/v2/generate
Mae API v2 yn defnyddio dilysu tocyn Bearer. I ddilysu, cynnwys eich tocyn API yn y Authorization pennawd:
Authorization: Bearer YOUR_API_TOKEN
Cael Eich Tocyn API
- Mewngofnodwch i'ch cyfrif Gwthiwr Cyfrinair
- Llywiwch i'ch tudalen tocynnau API
- Cynhyrchu tocyn API
- Copïwch y tocyn a'i ddefnyddio yn eich ceisiadau API
Nodyn: Gellir cael mynediad i rai pwyntiau terfyn (fel adfer gwthiad neu gais, neu gynhyrchu cyfrinair) yn ddienw. Mae creu ceisiadau, cael mynediad at logiau archwilio, a rheoli casgliadau yn gofyn am ddilysu. Cynhwyswch docyn Cludwr wrth gynhyrchu ceisiadau pan fydd angen y polisi gweithle wedi mewngofnodi arnoch.
Mae pob pwynt terfyn API wedi'i ragddodi â:
https://eu.pwpush.com/api/v2
Argaeledd Beta
Mae API v2 ar hyn o bryd mewn beta ac mae ar gael ar pwpush.com a rhifynnau Pro hunangynhaliol. Bydd yr API yn cael ei ychwanegu at y rhifyn ffynhonnell agored ar ôl iddo adael y beta.
Ar gyfer achosion hunangynhaliol, defnyddiwch eich parth eich hun. Mae'r URL sylfaenol a ddangosir uchod yn adlewyrchu'r gwesteiwr cyfredol rydych chi'n ei gyrchu.
GET /api/v2/version
Yn dychwelyd y fersiwn API gyfredol, manylion y rhaglen, a hash nodweddion sy'n disgrifio pa alluoedd sydd wedi'u galluogi ar yr achos hwn.
Cais Enghraifft
curl -X GET https://eu.pwpush.com/api/v2/version
Ymateb Enghraifft
{
"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
}
}
}
}Nodweddion Hash
mynediad_anonymous - A ganiateir defnyddio API dienw
dilysu_tocyn_api - Cymorth dilysu tocyn cludwr
generadur_cyfrinair.wedi'i alluogi - A yw cynhyrchu cyfrinair, cyfrinair-ymadrodd, a PIN wedi'i alluogi
iaith_generadur_cyfrinyddion - Ieithoedd rhestr geiriau cyfrinair a gefnogir
cyfrifon.wedi'u galluogi - A yw rhestr o leoedd gwaith ar gael yn /api/v2/workspaces (mae'r llwybr etifeddol /api/v2/accounts yn enw arall)
gwthio.wedi'i alluogi - Creu a rheoli gwthio trwy API
gwthio.e-bost_anfon_awtomatig - A all yr achos hwn e-bostio dolenni cyfrinachol wrth greu. Canfod nodweddion yn unig — defnyddiwch y paramedr notify_recipients create i optio allan o Anfon yn Awtomatig tra'n dal i gyflenwi notify_emails_to ar gyfer Derbynwyr Dilys.
gwthio.atodiadau_ffail.wedi'u galluogi - Atodiadau ffeiliau ar wthio
gwthio.atodiadau_ffail.angen_dilysu - Mae angen dilysu atodiadau ffeiliau
ceisiadau.wedi'u galluogi - Creu a rheoli ceisiadau drwy API
ceisiadau.ebost_anfon_awtomatig - A all yr achos hwn e-bostio dolenni cyfrinachol wrth greu. Canfod nodweddion yn unig — defnyddiwch y paramedr notify_recipients create i optio allan o Anfon yn Awtomatig tra'n dal i gyflenwi notify_emails_to ar gyfer Derbynwyr Dilys.
ceisiadau.atodiadau_ffail.wedi'u galluogi - Atodiadau ffeiliau ar ymatebion cais
ceisiadau.atodiadau_ffail.angen_dilysu - Mae angen dilysu atodiadau ffeiliau
POST /api/v2/generate
Yn creu un neu fwy o gyfrineiriau, ymadroddion cyfrin, neu rifau PIN. Mae dilysu yn ddewisol. Mae ceisiadau dienw yn defnyddio'r polisi gweithle craidd (neu bolisi byd-eang hunangynhaliol). Anfonwch docyn Cludwr i ddefnyddio'r polisi gweithle wedi mewngofnodi, gan gynnwys ar barthau personol.
Pan fydd ffurfweddiad generadur wedi'i analluogi gan bolisi, anwybyddir gorbwysiadau opsiynau a dim ond cyfrif sy'n cael ei anrhydeddu.
Os yw cynhyrchu cyfrinair wedi'i analluogi, mae'r API yn dychwelyd 403 Gwaharddedig.
Mae cynhyrchu wedi'i gyfyngu i 30 cais y funud fesul cyfeiriad IP neu ddefnyddiwr dilys.
Corff y Cais (JSON)
Anfon paramedrau wrth wreiddyn y gwrthrych JSON. Mae meysydd sydd wedi'u hepgor yn disgyn yn ôl i'r rhagosodiadau polisi effeithiol.
| Paramedr | Math | Disgrifiad |
|---|---|---|
workspace_id
dewisol
|
string | Gweithle dilys i gymhwyso polisi ohono. Hefyd yn derbyn account_id. Yn dychwelyd 401 os nad yw'r galwr yn aelod o'r gweithle hwnnw. |
type
dewisol
|
string | cyfrinair, cyfrinair-ymadrodd, neu PIN |
count
dewisol
|
integer (1-10) | Nifer o werthoedd i'w cynhyrchu |
language
dewisol
|
string | Rhestr geiriau cyfrinair: en, es, fr, de, neu it |
word_count
dewisol
|
integer (3-10) | Nifer y geiriau mewn cyfrinair |
separator
dewisol
|
string | Llinyn wedi'i fewnosod rhwng geiriau cyfrinair |
capitalize
dewisol
|
boolean | Priflythrennwch bob gair cyfrinair |
number
dewisol
|
boolean | Ychwanegu digidau at gyfrinair |
symbol
dewisol
|
boolean | Ychwanegu symbol at gyfrinair |
length
dewisol
|
integer | Hyd y cyfrinair (4–128) neu hyd y PIN (4–12) |
uppercase
dewisol
|
boolean | Cynnwys llythrennau mawr mewn cyfrineiriau |
lowercase
dewisol
|
boolean | Cynnwys llythrennau bach mewn cyfrineiriau |
digits
dewisol
|
boolean | Cynnwys digidau mewn cyfrineiriau |
symbols
dewisol
|
boolean | Cynnwys symbolau mewn cyfrineiriau |
avoid_ambiguous
dewisol
|
boolean | Eithrio cymeriadau amwys fel 0, O, l, ac 1 |
min_digits
dewisol
|
integer | Isafswm nifer y digidau mewn cyfrinair |
min_symbols
dewisol
|
integer | Isafswm nifer o symbolau mewn cyfrinair |
charset
dewisol
|
string | Rhagosodiad llythrennau: ascii, Lladin, Cyrilig, neu Groeg. Caiff unrhyw werth arall ei drin fel pwll nodau personol. |
Meysydd Ymateb
| Maes | Disgrifiad |
|---|---|
type |
cyfrinair, cyfrinair-ymadrodd, neu PIN |
language |
Yn bresennol ar gyfer cyfrineiriau. Y rhestr geiriau a ddefnyddir i gynhyrchu'r canlyniad. |
entropy_bits |
Cryfder amcangyfrifedig a ddychwelwyd yn yr ymateb. Gweler entropi fel mesur o gryfder cyfrinair. |
results |
Arae o linynnau a gynhyrchwyd |
Cais Enghraifft
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
}'Ymateb Enghraifft
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Enghraifft o Gyfrinair
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
}'Enghraifft: Creu ac Adalw Gwthiad
# 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/fkwjfvhall92Enghraifft: Creu Cais ac Ymateb
# 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"
}
}'Gwladwriaethau Cais
Mae'r API yn defnyddio codau statws HTTP safonol:
200 OK
Cais wedi llwyddo
201 Created
Adnodd wedi'i greu
400 Bad Request
Paramedrau annilys
422 Unprocessable Entity
Gwallau dilysu neu ddata cais annilys
401 Unauthorized
Mae angen dilysu
403 Forbidden
Mynediad wedi'i wrthod
404 Not Found
Ni chanfuwyd yr adnodd
Mae cyfyngu ar gyfraddau wedi'i weithredu i amddiffyn yr API rhag camdriniaeth a sicrhau defnydd teg i bob defnyddiwr. Mae cyfyngiadau cyfraddau yn cael eu cymhwyso fesul cyfeiriad IP ac yn amrywio yn dibynnu ar y math o gais a'r pwynt terfyn.
Mae ceisiadau GET log archwilio wedi'u cyfyngu i 15 cais y funud fesul IP, gyda therfyn byrstio o 5 cais bob 10 eiliad, a 30 cais y funud fesul defnyddiwr dilys neu docyn API.
Ymatebion Terfyn Cyfradd
Pan fydd cais yn fwy na'r terfyn cyfradd, mae'r API yn dychwelyd 429 Too Many Requests cod statws gyda Retry-After pennawd sy'n nodi pryd y gallwch chi ail-geisio'r cais.
Arferion Gorau
- Gweithredu cefnu esbonyddol pan fyddwch chi'n derbyn ymateb 429
- Parchu'r
Retry-Aftergwerth y pennawd - Ymatebion yn y storfa pan fo'n briodol i leihau galwadau API
- Gweithrediadau swp pan fo'n bosibl yn lle gwneud llawer o geisiadau unigol
- Monitro defnydd API eich rhaglen i osgoi taro terfynau
Nodyn: Mae terfynau cyfradd wedi'u cynllunio i atal camdriniaeth wrth ganiatáu defnydd cyfreithlon. Os ydych chi'n dod ar draws terfynau cyfradd yn gyson, ystyriwch optimeiddio'ch integreiddiad neu gysylltu â chymorth i drafod eich achos defnydd.
Diweddarwyd ddiwethaf: October 22, 2026