Password Pusher API v2
BETA비밀번호 푸셔를 워크플로, 애플리케이션 및 도구에 통합하기 위한 종합적인 REST API 설명서를 확인하세요.
베타 공지: API v2는 현재 베타 버전입니다. 안정성을 보장하기 위해 최선을 다하고 있지만 최종 릴리스 전에는 획기적인 변경 사항이 있을 수 있습니다. 여러분의 피드백을 환영합니다!
개요
비밀번호 푸셔 API v2는 보안 비밀번호 푸시 및 요청을 생성, 검색, 관리할 수 있는 RESTful 인터페이스를 제공합니다. 모든 API 엔드포인트는 JSON 응답을 반환하고 표준 HTTP 상태 코드를 사용합니다.
무기명 토큰 인증
토큰 기반 인증으로 API 액세스 보호
JSON 전용 응답
모든 엔드포인트에서 일관된 JSON 형식 사용
RESTful 디자인
모범 사례를 따르는 직관적인 REST 엔드포인트
푸시 및 요청
단방향 푸시 및 양방향 요청 지원
비밀번호 생성기
POST /api/v2/generate를 통해 비밀번호, 패스프레이즈 및 PIN 생성하기
API v2는 베어러 토큰 인증을 사용합니다. 인증을 받으려면 API 토큰을 Authorization 헤더:
Authorization: Bearer YOUR_API_TOKEN
API 토큰 받기
- 비밀번호 푸셔 계정에 로그인
- API 토큰 페이지로 이동합니다
- API 토큰 생성
- 토큰을 복사하여 API 요청에 사용하세요
참고: 일부 엔드포인트(푸시 알림 또는 요청 수신, 비밀번호 생성 등)는 익명으로 액세스할 수 있습니다. 요청 생성, 감사 로그 조회 및 컬렉션 관리에는 인증이 필요합니다. 로그인된 작업 공간 정책이 필요한 경우, 요청 생성 시 Bearer 토큰을 포함시켜야 합니다.
모든 API 엔드포인트에는 접두사가 붙습니다:
https://eu.pwpush.com/api/v2
베타 버전 제공
API v2는 현재 베타 버전이며 다음에서 사용할 수 있습니다 pwpush.com 및 자체 호스팅 프로 에디션에서 사용할 수 있습니다. 베타 버전이 종료된 후 오픈 소스 버전에 API가 추가될 예정입니다.
자체 호스팅 인스턴스의 경우 자체 도메인을 사용합니다. 위에 표시된 기본 URL은 현재 액세스 중인 호스트를 반영합니다.
GET /api/v2/version
현재 API 버전, 애플리케이션 세부 정보 및 이 인스턴스에서 활성화된 기능을 설명하는 기능 해시를 반환합니다.
요청 예시
curl -X GET https://eu.pwpush.com/api/v2/version
응답 예시
{
"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
}
}
}
}
기능 해시
익명 액세스 - 익명 API 사용 허용 여부
aPI_토큰_인증 - 무기명 토큰 인증 지원
password_generator.enabled - 비밀번호, 패스프레이즈 및 PIN 생성이 활성화되어 있는지 여부
password_generator.languages - 지원되는 암호 문구 단어 목록 언어
accounts.enabled - 작업 공간 목록이 /api/v2/작업 공간에서 사용 가능한지 여부(레거시 경로 /api/v2/accounts는 별칭입니다)
푸시.활성화 - API를 통한 푸시 생성 및 관리
푸시.이메일_자동발송 - 이 인스턴스가 생성 시 비밀 링크를 이메일로 보낼 수 있는지 여부. 기능 확인용일 뿐입니다. 자동 발송을 비활성화하되, 인증된 수신자에 대해서는 notify_emails_to 매개변수를 계속 제공하려면 notify_recipients create 매개변수를 사용하십시오.
pushes.file_attachments.enabled - 푸시 시 첨부 파일
pushes.file_attachments.requires_인증 - 파일 첨부 시 인증 필요
requests.enabled - API를 통한 요청 생성 및 관리
requests.email_auto_dispatch - 이 인스턴스가 생성 시 비밀 링크를 이메일로 보낼 수 있는지 여부. 기능 확인용일 뿐입니다. 자동 발송을 비활성화하되, 인증된 수신자에 대해서는 notify_emails_to 매개변수를 계속 제공하려면 notify_recipients create 매개변수를 사용하십시오.
requests.file_attachments.enabled - 요청 응답에 첨부 파일
requests.file_attachments.requires_인증 - 파일 첨부 시 인증 필요
POST /api/v2/generate
하나 이상의 비밀번호, 암호문 또는 PIN을 생성합니다. 인증은 선택 사항입니다. 익명 요청의 경우 핵심 워크스페이스(또는 자체 호스팅 글로벌) 정책이 적용됩니다. 사용자 지정 도메인을 포함하여 로그인된 워크스페이스 정책을 사용하려면 Bearer 토큰을 전송하십시오.
정책에 의해 생성기 구성이 비활성화된 경우, 옵션 재정의는 무시되고 카운트만 적용됩니다.
비밀번호 생성이 비활성화된 경우, API는 403 Forbidden 오류를 반환합니다.
생성 횟수는 IP 주소 또는 인증된 사용자당 분당 30건으로 제한됩니다.
요청 본문(JSON)
매개변수는 JSON 객체의 최상위 레벨에 지정하십시오. 생략된 필드는 해당 정책의 기본값으로 대체됩니다.
| 매개변수 | 유형 | 설명 |
|---|---|---|
workspace_id
선택 과목
|
string | 정책을 적용할 인증된 작업 공간입니다. account_id도 허용됩니다. 호출자가 해당 작업 공간의 구성원이 아닌 경우 401을 반환합니다. |
type
선택 과목
|
string | 비밀번호, 비밀문구 또는 PIN |
count
선택 과목
|
integer (1-10) | 생성할 값의 개수 |
language
선택 과목
|
string | 패스프레이즈 단어 목록: en, es, fr, de 또는 it |
word_count
선택 과목
|
integer (3-10) | 패스프레이즈의 단어 수 |
separator
선택 과목
|
string | 암호 문구 단어 사이에 삽입된 문자열 |
capitalize
선택 과목
|
boolean | 각 패스프레이즈 단어의 첫 글자를 대문자로 표기하십시오 |
number
선택 과목
|
boolean | 패스프레이즈에 숫자를 추가하기 |
symbol
선택 과목
|
boolean | 패스프레이즈에 기호를 추가하기 |
length
선택 과목
|
integer | 비밀번호 길이 (4–128) 또는 PIN 길이 (4–12) |
uppercase
선택 과목
|
boolean | 비밀번호에 대문자를 포함하십시오 |
lowercase
선택 과목
|
boolean | 비밀번호에 소문자를 포함하세요 |
digits
선택 과목
|
boolean | 비밀번호에 숫자를 포함하세요 |
symbols
선택 과목
|
boolean | 비밀번호에 특수 문자를 포함하세요 |
avoid_ambiguous
선택 과목
|
boolean | 0, O, l, 1과 같이 혼동될 수 있는 문자는 제외하십시오. |
min_digits
선택 과목
|
integer | 비밀번호의 최소 자릿수 |
min_symbols
선택 과목
|
integer | 비밀번호의 최소 기호 개수 |
charset
선택 과목
|
string | 문자 사전 설정: ascii, latin, cyrillic 또는 greek. 이 외의 값은 사용자 정의 문자 집합으로 처리됩니다. |
응답 필드
| 필드 | 설명 |
|---|---|
type |
비밀번호, 비밀문구 또는 PIN |
language |
패스프레이즈에 대한 값. 결과를 생성하는 데 사용된 단어 목록. |
entropy_bits |
응답에 예상 강도가 반환되었습니다. 참조: 비밀번호의 강도를 측정하는 지표로서의 엔트로피. |
results |
생성된 문자열 배열 |
요청 예시
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
}'
응답 예시
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
비밀번호 예시
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
}'
예시: 푸시 생성 및 검색
# 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
예시: 요청 생성 및 응답
# 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"
}
}'
요청 상태
API는 표준 HTTP 상태 코드를 사용합니다:
200 OK
요청이 성공했습니다
201 Created
생성된 리소스
400 Bad Request
잘못된 매개 변수
422 Unprocessable Entity
유효성 검사 오류 또는 유효하지 않은 요청 데이터
401 Unauthorized
인증 필요
403 Forbidden
액세스 거부됨
404 Not Found
리소스를 찾을 수 없습니다
속도 제한은 API를 남용으로부터 보호하고 모든 사용자에게 공정한 사용을 보장하기 위해 시행됩니다. 속도 제한은 IP 주소별로 적용되며 요청 유형과 엔드포인트에 따라 달라집니다.
감사 로그 GET 요청은 IP당 분당 15회로 제한되며, 10초당 최대 5회까지 집중 요청이 허용됩니다. 또한 인증된 사용자 또는 API 토큰당 분당 30회로 제한됩니다.
속도 제한 응답
요청이 속도 제한을 초과하면 API는 다음을 반환합니다 429 Too Many Requests 상태 코드와 함께 Retry-After 헤더는 요청을 다시 시도할 수 있는 시기를 나타냅니다.
모범 사례
- 429 응답을 받을 때 지수 백오프 구현하기
- 존중
Retry-After헤더 값 - 적절한 경우 응답을 캐시하여 API 호출을 줄입니다
- 개별 요청을 많이 하지 말고 가능하면 일괄 작업으로 처리하세요
- 애플리케이션의 API 사용량을 모니터링하여 한도에 도달하지 않도록 하세요
참고: 요금 제한은 남용을 방지하는 동시에 합법적인 사용을 허용하기 위해 고안된 기능입니다. 요금 제한이 지속적으로 발생하는 경우 통합을 최적화하거나 지원팀에 문의하여 사용 사례에 대해 논의하세요.
마지막으로 업데이트되었습니다: October 15, 2026