API 문서

인증

API 인증

모든 API 요청은 API 키를 사용하여 인증이 필요합니다. 이 가이드는 API 키를 안전하게 생성, 관리 및 사용하는 방법을 설명합니다.

API 키 받기

API 키를 받으려면 iloveQR 계정이 필요하고 조직의 일원이 되어야 합니다.

계정에 로그인

로그인하거나 계정이 없으면 계정을 생성하세요.

개발자 페이지로 이동

대시보드 → 개발자로 가서 API 키를 관리하세요.

새 API 키 생성

'API 키 생성'을 클릭하고 설명적인 이름을 지정한 후 생성된 키를 안전하게 저장하세요.

API 키 사용하기

모든 요청에 대해 X-API-Key 헤더에 API 키를 포함하세요:

요청 헤더

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

조직 ID

대부분의 API 엔드포인트는 URL 경로에 조직 ID가 필요합니다. 대시보드 설정에서 조직 ID를 찾거나 조직 엔드포인트에 요청하여 확인할 수 있습니다.

조직 가져오기

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

응답

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

보안 모범 사례

클라이언트 측 코드에서 API 키를 노출하지 마세요

항상 서버에서 API 호출을 하세요. 브라우저, 모바일 앱 또는 사용자가 볼 수 있는 코드에서 API 키를 포함하지 마세요.

환경 변수 사용

API 키를 코드베이스가 아닌 환경 변수에 저장하세요. 이렇게 하면 버전 관리로 인한 우발적인 노출을 방지할 수 있습니다.

정기적으로 키 회전

주기적으로 새 API 키를 생성하고 이전 키를 취소하세요. 키가 유출된 것으로 의심되면 즉시 취소하세요.

인증 오류

인증이 실패하면 API는 다음과 같은 오류 응답 중 하나를 반환합니다:

상태 코드	오류	설명
401	UNAUTHORIZED	누락되거나 잘못된 API 키
403	FORBIDDEN	API 키가 이 작업에 대한 권한이 없습니다
403	API_KEY_REVOKED	API 키가 취소되었습니다

예시 오류 응답

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

다음 단계

이제 인증을 이해했으니 API 사용 방법을 배우세요: