SocFlow LogoSocFlow

인증 방법

SocFlow API를 사용하기 위해서는 요청을 인증해야 합니다. 이 가이드에서는 API 키를 발급받고 안전하게 사용하는 방법을 알아봅니다.

모든 API 요청은 HTTPS를 통해 이루어져야 하며, 인증되지 않은 요청은 거부됩니다.

API 키 발급

API 키는 SocFlow 대시보드에서 간편하게 발급받을 수 있습니다:

  1. SocFlow에 로그인합니다
  2. 대시보드 메뉴에서 API 키 페이지로 이동합니다
  3. 새 API 키 생성 버튼을 클릭합니다
  4. 키 이름을 입력하고 생성합니다
  5. 생성된 API 키를 안전한 곳에 보관합니다

API 키는 생성 시 한 번만 표시됩니다. 반드시 안전한 곳에 보관하세요.

대시보드에서 API 키 발급받기

API 키 사용

SocFlow API는 X-Secret-Token 헤더를 통해 인증을 수행합니다. 모든 API 요청에 이 헤더를 포함해야 합니다.

헤더 형식

API 키는 요청 헤더에 다음과 같이 포함합니다:

  • Name
    X-Secret-Token
    Description

    발급받은 API 키 값을 그대로 전달합니다. Bearer나 다른 접두사는 필요하지 않습니다.

curl --location 'https://api.socflow.app/api/v1/accounts/social' \
--header 'X-Secret-Token: {YOUR_API_KEY}'

인증 오류

인증에 실패하면 다음과 같은 에러 응답을 받게 됩니다:

일반적인 인증 오류

  • Name
    401 Unauthorized
    Description

    API 키가 누락되었거나 잘못되었습니다. 헤더에 올바른 API 키가 포함되어 있는지 확인하세요.

  • Name
    403 Forbidden
    Description

    API 키는 유효하지만 해당 리소스에 접근할 권한이 없습니다.

401 에러 응답

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key provided",
    "code": "invalid_api_key"
  }
}

보안 모범 사례

API 키를 안전하게 관리하기 위한 권장 사항:

환경 변수 사용

코드에 API 키를 직접 입력하지 말고 환경 변수를 사용하세요. 이렇게 하면 소스 코드에 민감한 정보가 노출되지 않습니다.

SOCFLOW_API_KEY=your_api_key_here

키 관리 체크리스트

  • Name
    ✓ 환경 변수 사용
    Description

    코드에 API 키를 하드코딩하지 마세요

  • Name
    ✓ Git에서 제외
    Description

    .env 파일을 .gitignore에 추가하세요

  • Name
    ✓ 키 순환
    Description
    정기적으로 API 키를 갱신하세요
  • Name
    ✓ 최소 권한 원칙
    Description

    필요한 권한만 부여된 API 키를 사용하세요

  • Name
    ✓ 키 모니터링
    Description

    대시보드에서 API 키 사용 내역을 정기적으로 확인하세요

키 유출 시 대응

API 키가 유출되었다면 즉시 대시보드에서 해당 키를 삭제하고 새로운 키를 발급받으세요. 유출된 키는 즉시 무효화됩니다.

Was this page helpful?