시작하기

API 키로 인증하기

두 가지 가격 엔드포인트를 제외한 모든 엔드포인트는 Authorization 헤더에 API 키가 필요해요.

POST /v1/messages HTTP/1.1
Host: bulksmsapi.cc
Authorization: Bearer bsa_live_7QzX2mW9kR4tB8nV1cJ6yP3sH5dL0aFe
Content-Type: application/json

키 생성하기

  • API 키는 콘솔의 API 키 페이지에서 생성돼요. 첫 충전이 잔액에 추가된 후 페이지가 열려요.
  • 하나의 계정은 최대 10개의 활성 키를 보유할 수 있어요. 각 앱이나 환경에 고유한 키와 이름을 부여해서, 하나를 교체할 때 다른 것들을 건드리지 않도록 하세요.
  • 키는 bsa_live_ 뒤에 32자의 영문자와 숫자로 구성돼요. 생성될 때 한 번만 표시되며, 키 해시만 저장하기 때문에 분실한 키는 다시 표시할 수 없어요. 대신 새 키를 생성하세요.
  • 목록에는 첫 번째 문자, 마지막 네 자리, 키가 생성된 시점, 마지막으로 사용된 시점이 표시돼요.

키 교체 및 취소하기

다운타임 없이 키를 교체하려면: 두 번째 키를 생성하고 배포한 후, 콘솔에서 마지막 사용 시간을 확인한 뒤 이전 키를 취소하세요. 취소된 키는 다음 요청부터 401 unauthorized 응답을 반환해요.

키 안전하게 보관하기

  • API를 서버에서 호출하세요. 브라우저나 모바일 앱에서는 호출하지 마세요. 키를 가진 누구나 잔액에서 메시지를 보낼 수 있어요.
  • 키를 소스 컨트롤이 아닌 환경 변수나 비밀 관리자에 보관하세요.
  • 각 키마다 별도의 요청 한도 카운터가 있어서, 한 키가 바쁘게 사용되더라도 다른 곳에서 사용되는 두 번째 키는 느려지지 않아요.

에러

401 UnauthorizedJSON
{
  "error": {
    "code": "unauthorized",
    "message": "Send your API key as Authorization: Bearer bsa_live_... Keys are created in the console under API keys.",
    "doc_url": "https://bulksmsapi.cc/en/docs/errors#unauthorized"
  }
}
API 키로 인증하기 | BulkSMSAPI 문서