인증

FourA API에 대한 모든 request는 인증이 필요합니다. 이 페이지에서는 API 키를 발급받고, 사용하며, 관리하는 방법을 설명합니다.

API 키 발급받기

1. FourA Dashboard에 로그인합니다.
2. API Keys 페이지로 이동합니다.
3. Create Key를 클릭합니다.
4. 확인 대화상자에서 키를 복사합니다.

API 키의 형식은 다음과 같습니다: pk_live_a1b2c3d4e5f6...

최근에 생성된 키는 다시 확인할 수 있습니다. 나중에 키 행의 눈 모양 아이콘을 클릭하면 필요할 때 전체 시크릿을 다시 볼 수 있습니다 (확인 프로세스 및 권한에 대한 자세한 내용은 Managing API Keys를 참조하세요). 이 기능이 도입되기 전에 생성된 레거시 키는 다시 볼 수 없으며 자물쇠 아이콘이 표시됩니다. 이 경우 키를 한 번 다시 생성하여 전환해야 합니다.

API 키 사용하기

모든 request의 X-API-Key header에 API 키를 포함합니다:

curl -X POST https://eu.api.foura.ai/api/single/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method": "GET", "url": "https://example.com"}'

Python의 경우:

import requests

response = requests.post(
    "https://eu.api.foura.ai/api/single/",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={"method": "GET", "url": "https://example.com"}
)

Node.js의 경우:

const response = await fetch('https://eu.api.foura.ai/api/single/', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});

API 키 보안

API 키를 비밀번호처럼 취급해야 합니다:

• 버전 관리에 커밋하지 마세요. 대신 환경 변수를 사용하세요.
• 클라이언트 측 코드에 노출하지 마세요. 서버 측 애플리케이션에서만 사용하세요.
• 유출된 경우 교체하세요. Dashboard에서 키를 다시 생성하세요. 이전 시크릿은 즉시 작동을 멈추며, 모든 확인 기록은 감사 로그에 남으므로 유출된 자격 증명을 사후에 쉽게 발견할 수 있습니다.

환경 변수 사용하기

환경 변수에 키를 저장합니다:

export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."

그런 다음 코드에서 참조합니다:

import os
api_key = os.environ["FOURA_API_KEY"]

const apiKey = process.env.FOURA_API_KEY;

일반적인 인증 오류

모든 인증 실패는 401 Unauthorized 상태를 반환합니다.

성공 및 실패를 포함한 모든 response에는 X-Foura-Request-Id header가 포함됩니다. 고객 지원팀이 나중에 특정 호출을 조회할 수 있도록 사용 측에서 이를 기록해 두세요.

다음 단계

• Quick Start: 첫 번째 request 만들기
• Managing API Keys: 키 확인, 편집, 재생성 및 삭제
• API Endpoints: 전체 endpoint 레퍼런스
• Error Handling: 인증 오류를 원활하게 처리하기