Docs인증 (Auth)

인증 (Authentication)

인증이 필요한 모든 Findip API 요청은 X-API-Key 헤더에 API 키를 포함해야 합니다.

API 키 형식

API 이용은 문의해 주시면 계약 방법을 안내해 드립니다. API 키는 pmk_live_ 로 시작합니다. API 종량 계약의 청구 담당 계정으로 로그인하신 뒤 대시보드의 API 키 화면에서 직접 발급하고 회수하실 수 있습니다.

발급된 키의 전체 값은 발급 직후 한 번만 보입니다. 저희도 전체 값을 보관하지 않으므로, 그 자리에서 복사해 안전한 곳에 저장해 주세요. 잃어버리신 키는 다시 볼 수 없으니 새로 발급하시고 이전 키는 회수해 주세요.
발급 후 화면에는 키 이름과 앞자리(pmk_live_…)만 표시됩니다.
선불 충전 계약은 첫 충전을 하신 뒤부터 키를 발급받으실 수 있습니다.

주의

API 키를 안전하게 보관하세요. 클라이언트 사이드 코드, 공개 저장소(Public Repository), 또는 브라우저 요청에 노출되지 않도록 하세요. 서버 환경 변수나 서버 사이드 프록시를 사용해야 합니다.

인증된 요청 보내기

API 키를 X-API-Key 헤더에 포함하세요. (Bearer 접두사는 사용하지 않습니다.)

cURL

curl -X POST https://api.findip.ai/api/v1/search/semantic \
-H "X-API-Key: pmk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{"query": "semiconductor etching process", "top_k": 5}'

Python

import requests

response = requests.post(
  "https://api.findip.ai/api/v1/search/semantic",
  headers={
      "X-API-Key": "pmk_live_your_api_key",
      "Content-Type": "application/json",
  },
  json={
      "query": "semiconductor etching process",
      "top_k": 5,
  },
)
data = response.json()

JavaScript (Node.js)

const response = await fetch("https://api.findip.ai/api/v1/search/semantic", {
method: "POST",
headers: {
  "X-API-Key": "pmk_live_your_api_key",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  query: "semiconductor etching process",
  top_k: 5,
}),
});
const data = await response.json();

공개 엔드포인트

GET /api/v1/drawings/..., GET /api/v1/stats/coverage, 헬스 체크는 X-API-Key 헤더가 필요하지 않습니다.

요청 한도 (Rate Limiting)

API 요청은 분당 60회로 제한되며, 모든 API 요청을 집계합니다. 한도에 도달하면 API는 429 Too Many Requests를 반환합니다.

과금 응답 헤더

API 종량 계약의 키로 호출하시면 응답에 다음 헤더가 붙습니다.

헤더	값
`X-Api-Krw-Charged`	이번 호출의 금액입니다. 성공한 응답에만 붙습니다. 문헌 조회는 요청 건수 기준이라 실제 차감액의 상한이며, 찾지 못한 문헌은 차감되지 않습니다.
`X-Api-Krw-Used`	이 키의 이번 달 누적 사용액입니다. 이번 호출은 아직 포함되지 않은 직전까지의 값입니다.
`X-Api-Cycle-End`	이번 주기의 마지막 날입니다 (`YYYY-MM-DD`).

값의 단위

값의 단위는 계약 통화를 따릅니다. 원화 계약은 원 단위입니다. 예를 들어 X-Api-Krw-Charged: 80 은 이번 호출이 80원이라는 뜻이고, X-Api-Krw-Used: 12500 은 이번 달 누적 사용액이 12,500원이라는 뜻입니다. 헤더 이름에 Krw 가 들어 있지만 USD 계약은 1/1000 USD 단위로 적히므로, 값을 1,000 으로 나누시면 달러 금액이 됩니다.

키 관리

대시보드의 API 키 화면에서 키를 직접 관리하실 수 있습니다.

환경(개발, 프로덕션)에 맞춰 여러 개의 키 발급
유출된 키를 즉시 회수(Revoke)
키별 사용량 확인

Search API Next: 에러 코드