본문으로 건너뛰기

API 키 관리

API 키는 Felice API를 사용하여 데이터를 가져오거나 수정할 때 사용할 수 있으며, 사용자 별로 최대 5개의 API 키를 생성할 수 있어요.

api_keys

API 키 발급하기​

내 설정 > API 키 관리 탭에서 [API 키 발급] 버튼을 눌러 새로운 API 키를 생성할 수 있어요. API 키는 키를 발급하는 사용자와 연결되어 해당 사용자의 역할 및 리소스 권한 를 그대로 부여받게 돼요.

키 발급 시 유의사항
  • 발급된 API 키의 유효기간은 변경할 수 없어요.
  • API 키는 사용자 별로 발급되는 비밀 키이므로 다른 사람과 공유하거나 클라이언트 코드에 노출시키지 마세요.
  • 사용자 계정이 삭제되거나 잠기면 해당 사용자가 발급한 모든 API 키도 함께 삭제되니 유의해주세요.
  • API 키의 유효기간을 [무기한 사용]으로 선택하면, 계정이 잠금/만료/삭제되기 전까지 계속 사용할 수 있어요.

create_api_keys

발급된 키 확인 및 복사​

발급된 API 키는 한 번만 확인할 수 있으며, 이후에는 확인할 수 없으니 꼭 복사하여 안전한 곳에 보관해주세요.

API 키를 잊어버리거나 분실하면 삭제 후 새로운 키를 발급해야 해요.

copy_secret_key

API 키 사용 방법​

HTTP Request Header​

curl --location "http://localhost:8989/v2/your-endpoint" \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: yourapikey' \ // 발급 받은 API 키
-X GET

Postman​

Authoization Type 을 API Key 로 지정한 후, X-API-KEY 를 [Key] 에 추가하고 [Value] 에 발급 받은 API 키를 입력하여 사용하세요.

postman

액세스 로그 조회​

키 목록 하단에서 현재 사용자가 발급한 API 키를 사용하여 이루어진 모든 API 요청 내역을 확인할 수 있어요. 키 구분 없이 최대 500개 까지의 액세스 로그를 조회할 수 있어요.

access_log

관리자 기능​

관리자 메뉴 > API 키 관리 메뉴에서 발급된 키들을 관리하세요. 관리자 권한을 가진 사용자만 다른 모든 사용자의 API 키를 조회하고 삭제할 수 있으며, 발생한 모든 액세스 로그도 함께 조회할 수 있어요. 액세스 로그는 특정 사용자 별로도 검색이 가능해요.