개발자 문서API

Once Email API

자동 이메일 테스트를 위한 공개 문서: 인증, 할당량, 오류와 안전한 사용 규칙.

문서는 공개되어 있습니다. API 키 생성과 실제 호출은 일반 공개되지 않았습니다. 아래 흐름은 이미 명시적인 API 접근 권한과 유효한 자격 증명을 받은 테스터만을 위한 것입니다.
인증

모든 요청에 Authorization: Bearer oe_live_… 를 보냅니다. 키는 한 번만 표시되므로 Secret Manager에 저장하고 브라우저 코드, 로그, Git에 넣지 마세요.

Authorization: Bearer oe_live_your_key
승인된 테스터를 위한 흐름
  1. 명시적으로 승인된 API 접근 권한과 필요한 최소 권한의 유효한 자격 증명을 이미 받은 경우에만 진행하세요. 자격 증명은 프로세스의 비밀 관리 기능에 보관하세요. 접근 권한이 없다면 문서와 다운로드 내용 검토까지만 진행하세요. 임시 받은편지함을 만들고 ID를 보관합니다.
  2. 테스트 시스템에서 해당 주소로 메일을 보냅니다.
  3. 백오프로 목록을 조회하고 빠른 빈 폴링을 피합니다.
  4. 대상 메일을 읽고 검증한 뒤 받은편지함을 삭제합니다.

비공개 베타 엔드포인트

POST /v1/inboxesGET /v1/inboxes/{inboxId}/messagesGET /v1/inboxes/{inboxId}/messages/{uid}GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid}DELETE /v1/inboxes/{inboxId}

상태 코드

400

잘못된 요청

401

키가 없거나 유효하지 않음

403

요금제 또는 리소스 거부

404

리소스를 찾을 수 없음

413

응답 또는 첨부가 너무 큼

429

속도 또는 월간 할당량 도달

503

일시적인 서비스 장애

클라이언트 제공 상태

TypeScript, Python, Java, Go, .NET, PHP, Ruby용 오픈 소스 후보 버전을 제공합니다. Linux, macOS, Windows 네이티브 CI를 통과했으며 언어 레지스트리에는 아직 배포하지 않았습니다.

결제 상태

Developer는 Stripe 월 구독과 월간 API 할당량을 사용합니다. 충전식 잔액은 제공하지 않습니다. 결제와 환불 검증 전까지 Live 결제는 닫혀 있습니다.

허용되는 사용

권한이 있는 시스템 테스트에만 사용하세요. 스팸, 정책 우회, 계정 악용, 타인 통신 감시, 개인정보 장기 보관은 금지됩니다.

API는 운영 준비 중입니다
공개 문서나 프리릴리스 다운로드는 API 접근 권한을 부여하지 않습니다. API 키 생성과 실제 호출은 일반 공개되지 않았습니다.

API Demo

안전한 크로스 플랫폼 예제

소유 또는 승인된 테스트 시스템용이며 Windows, Linux, macOS의 Node.js 20+에서 실행됩니다.

node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox
전체 Demo 열기

전체 사용 가이드

고정 버전 로컬 패키지 다운로드

소유하거나 명시적으로 승인된 앱만 테스트하세요. Once Email은 수신 전용입니다.

문서와 소스는 공개, API는 통제되며 SDK와 Skill은 레지스트리 외 후보 버전입니다. 공개 문서나 프리릴리스 다운로드는 API 접근 권한을 부여하지 않습니다. API 키 생성과 실제 호출은 일반 공개되지 않았습니다.

압축 해제 전 SHA256SUMS를 확인하세요.

정확한 로컬 시작점

node demos/api/authorized-workflow.mjs

다운로드부터 정리까지

  1. 소유 또는 승인을 확인하고 local, test, staging만 사용합니다.
  2. 명시적으로 승인된 API 접근 권한과 필요한 최소 권한의 유효한 자격 증명을 이미 받은 경우에만 진행하세요. 자격 증명은 프로세스의 비밀 관리 기능에 보관하세요. 접근 권한이 없다면 문서와 다운로드 내용 검토까지만 진행하세요.
  3. 다운로드, 검증, 압축 해제 후 문서를 읽습니다.
  4. Node.js 20+로 Demo를 실행하고 표시된 메일을 보냅니다.
  5. 마감 내 조회하고 유일한 항목만 읽습니다.
  6. finally에서 삭제하고 정리 실패를 별도로 처리합니다.

실패 및 복구

400/401/403/404/413/429/503, 시간 초과, 모호성, 추출, 검증과 정리를 구분하고 마감 전까지만 재시도하세요.