🔌 API 개요

FINGERPUSH.LINK REST API의 인증 방식, 공통 규칙, 에러 처리 등 모든 API에 공통으로 적용되는 내용을 안내합니다.

베이스 URL

모든 API 요청의 기본 주소: https://fpl-stage-console.kissoft.biz

API 종류

FINGERPUSH.LINK는 용도와 인증 방식에 따라 4가지 API 계층을 제공합니다.

API베이스 경로인증 방식용도
Service API /api/v1/service X-API-KEY 헤더 서버 간 통합 — URL·캠페인 CRUD, 통계 조회
App SDK API /api/v1/sdk/mobile X-App-ID + X-Mobile-App-API-Key 모바일 앱 SDK — 딥링크 해석, 퍼널 추적, 앱 설치 확인 (App SDK 연동 가이드 ↗)
Web SDK API /api/v1/sdk/web 인증 불필요 (App ID만 사용) 웹 브라우저 SDK — 세션 추적, 이벤트 기록, 핑거프린트
웹훅 수신 사용자 지정 URL X-Signature-256 HMAC 서명 이벤트 실시간 알림 — 클릭·캠페인·목표 달성·퍼널·세션

인증 방식

Service API 인증

콘솔 > 개발자 > API 키 관리에서 발급받은 API Key를 X-API-KEY 헤더에 전달합니다.

cURL — Service API
curl -X POST https://fpl-stage-console.kissoft.biz/api/v1/service/urls \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your-api-key-here" \
  -d '{"url": "https://example.com/landing"}'
📌 IP 화이트리스트 (선택)
콘솔 > 개발자 > IP 화이트리스트에서 허용할 IP를 등록하면, 등록된 IP에서만 API 호출이 가능합니다. 등록하지 않으면 모든 IP에서 호출할 수 있습니다.

App SDK API 인증

콘솔 > 모바일 앱 관리에서 앱을 등록하면 발급되는 App ID와 Mobile App API Key를 헤더에 전달합니다. 자세한 연동 방법은 App SDK 연동 가이드 ↗를 참고하세요.

cURL — App SDK API
curl -X GET "https://fpl-stage-console.kissoft.biz/api/v1/sdk/mobile/deeplink/match?token=abc123" \
  -H "X-App-ID: your-app-id" \
  -H "X-Mobile-App-API-Key: your-mobile-app-api-key"

Web SDK API

Web SDK API는 별도 인증이 필요하지 않습니다. SDK 초기화 시 App ID만 설정하면 됩니다.

공통 요청/응답 규칙

요청 형식

항목
Content-Typeapplication/json
문자 인코딩UTF-8
날짜/시간 형식ISO-8601 · UTC 기준 (예: 2026-01-15T14:30:00Z)
날짜 형식YYYY-MM-DD · UTC 기준 (예: 2026-01-15)

성공 응답

단건 조회·생성·수정은 JSON 객체, 목록 조회는 페이징 래퍼로 응답합니다.

JSON — 단건 응답
{
  "id": 123,
  "shortUrl": "https://fpl-stage-console.kissoft.biz/abc123",
  "originalUrl": "https://example.com/landing",
  "clickCount": 0,
  "createdAt": "2026-01-15T14:30:00"
}
JSON — 페이징 목록 응답
{
  "content": [ ... ],
  "totalElements": 142,
  "totalPages": 8,
  "number": 0,
  "size": 20
}

에러 응답

에러 발생 시 HTTP 상태 코드와 함께 다음 형식의 JSON이 반환됩니다.

JSON — 에러 응답
{
  "status": 400,
  "error": "Bad Request",
  "message": "URL은 필수 입력값입니다.",
  "timestamp": "2026-01-15T14:30:00"
}

자세한 에러 코드 목록은 에러 코드 레퍼런스를 참고하세요.

HTTP 상태 코드

코드의미설명
200OK요청 성공
201Created리소스 생성 성공
400Bad Request잘못된 요청 파라미터
401Unauthorized인증 실패 (API Key 누락 또는 유효하지 않음)
403Forbidden권한 없음 (IP 차단, 플랜 제한 등)
404Not Found리소스를 찾을 수 없음
409Conflict충돌 (중복 별칭 등)
429Too Many Requests요청 한도 초과 (Rate Limit)
500Internal Server Error서버 내부 오류

Rate Limiting

API 남용을 방지하기 위해 호출 횟수 제한이 적용됩니다.

항목제한
Service API플랜별 월간 호출 한도 적용
Mobile/Web SDK API초당 요청 수 제한

한도 초과 시 429 Too Many Requests 응답이 반환됩니다. 현재 사용량은 콘솔 > 개발자 > API 호출 한도에서 확인할 수 있습니다.

콘솔 개발자 메뉴

API 키 발급, 웹훅 설정, 사용량 모니터링 등 개발에 필요한 기능은 콘솔의 개발자 메뉴에서 이용할 수 있습니다.

메뉴설명
API 키 관리Service API 호출에 필요한 API Key 발급·재생성·삭제
웹훅이벤트 발생 시 외부 URL로 실시간 HTTP POST 알림 설정
IP 화이트리스트API 호출을 허용할 IP 주소 관리
API 호출 한도API 사용량 모니터링 및 호출 한도 확인
API 문서인터랙티브 API 레퍼런스 (콘솔 내장)
SDK 플레이그라운드API를 브라우저에서 직접 테스트

API 문서 가이드

목적에 맞는 문서를 선택하세요.

문서내용
Service API 레퍼런스 URL API (7), 캠페인 API (5), 모바일 앱 통계 API (3) — 총 15개 엔드포인트 상세 명세
웹훅 연동 가이드 이벤트 타입, HMAC 서명 검증, 페이로드 예시, 수신 서버 구현 코드 (Java/Python/Node/JSP/PHP)
Web SDK 연동 가이드 fplink-tracker.js 삽입부터 세션·이벤트·퍼널 추적까지 단계별 따라하기
App SDK 연동 가이드 ↗ iOS/Android 네이티브 앱 SDK 연동 — 딥링크 매칭, 퍼널 추적, 앱 설치 확인
에러 코드 HTTP 상태 코드별 에러 응답 형식 및 에러 코드 목록