API

빠른 시작

키 하나와 첫 발송.

1. 키 만들기

설정 → API 키를 엽니다. 이 페이지는 메일함을 소유한 경우에만 보입니다.
키를 사용할 대상의 이름을 붙이십시오. 무언가를 취소해야 할 때 그 이름으로 다시 찾게 됩니다.
스코프를 고르십시오. 기본값은 발송 전용입니다.
원한다면 무엇으로 보낼 수 있는지도 좁히십시오. 도메인 전체, 개별 주소, 또는 둘 다. 도메인 전체는 나중에 추가되는 주소도 포함합니다.
키를 복사하십시오. 한 번만 표시되고 복구할 수 없습니다. 저장되는 것은 단방향 해시입니다. 나중에 키를 교체해도 새 키가 같은 방식으로 한 번만 표시됩니다.

2. 무언가 보내기

npm install @openemail/sdk

선택 사항입니다. 모든 엔드포인트는 평범한 HTTP와 JSON이며, 아래 curl 탭은 아무것도 설치할 필요가 없습니다.

curl -X POST https://api.openemail.uk/emails \  -H "Authorization: Bearer $OPENEMAIL_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "from": "Acme Billing <[email protected]>",    "to": ["[email protected]"],    "subject": "Your September invoice",    "html": "<p>Invoice attached.</p>"  }'

200이면 발송된 것입니다. id를 돌려받습니다. 보관하십시오. 메시지를 조회하고, 이벤트 기록을 읽고, 예약한 경우 취소하는 데 쓰입니다.

예상하지 못한 403을 받으셨나요? GET /addresses가 이 키로 보낼 수 있는 주소를 정확히 나열합니다. 거의 항상 워크스페이스에 도메인이 없어서가 아니라, 키의 발송 스코프이거나 키에 주어지지 않은 도메인 또는 주소 때문입니다.