인증

badges.ninja로 보내는 모든 API 요청에는 인증이 필요합니다. 이 페이지에서는 요청을 인증하는 방법을 설명해요.

기본 URL

https://api.badges.ninja

모든 API 엔드포인트는 이 기본 URL에 대한 상대 경로예요.

API 키 인증

기본 인증 방식은 X-Api-Key 헤더에 API 키를 담아 전달하는 것입니다.

API 키 발급받기

대시보드에서:

badges.ninja에 로그인하세요.
사이드바에서 API 키로 이동하세요.
API 키 생성을 클릭하세요.
키를 복사하세요(한 번만 표시돼요).

API에서:

Cognito 인증 흐름에서 받은 JWT 토큰을 사용해 API로도 API 키를 관리할 수 있어요. 가장 간단한 방법은 대시보드를 이용하는 것입니다.

API 키 사용하기

모든 요청에 X-Api-Key 헤더를 포함하세요.

bash

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

API 키 형식

키는 bws_ 접두사를 사용해요.

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

요청 형식

GET 요청은 파라미터를 쿼리 문자열로 전달해요
POST 및 PUT 요청은 parameters 객체가 포함된 JSON 본문을 보내요
모든 응답은 Content-Type: application/json과 함께 JSON으로 반환돼요

POST/PUT 요청 구조

json

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

요청 예시

bash

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

응답 예시

json

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

공개 엔드포인트

일부 엔드포인트는 인증이 필요하지 않아요. /certify-badge/ 아래에 있는 공개 검증 엔드포인트가 이에 해당하며, 누구나 배지 자격 증명을 검증할 수 있습니다.

인증 ​

기본 URL ​

API 키 인증 ​

API 키 발급받기 ​

API 키 사용하기 ​

API 키 형식 ​

요청 형식 ​

POST/PUT 요청 구조 ​

요청 예시 ​

응답 예시 ​

공개 엔드포인트 ​

인증