🚀 Rankly API

검색 순위 추적 플랫폼

📖 프로젝트 소개

Rankly는 네이버 쇼핑, 쿠팡 등 주요 플랫폼의 검색 순위를 추적하고 관리하는 종합 플랫폼입니다. 슬롯 관리, 순위 모니터링, 정산, 구독 관리 등 다양한 기능을 제공합니다.

이 API는 Django와 Django Ninja를 기반으로 구축되었으며, RESTful API 원칙을 따르며 JWT 기반 인증을 사용합니다.

🔗 주요 링크

📚 Swagger UI (API 문서 및 테스트):
https://rankly.kr/api/v1/docs 추천
📄 OpenAPI JSON 스펙:
https://rankly.kr/api/v1/openapi.json
⚙️ Django Admin:
https://rankly.kr/admin/

📝 Swagger 사용법

1. Swagger UI 접속

위의 Swagger UI 링크를 클릭하여 API 문서 페이지로 이동합니다.

2. 인증 토큰 설정

  1. Swagger UI 상단의 "Authorize" 버튼 클릭
  2. Bearer {token} 형식으로 토큰 입력
  3. 예: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...
  4. "Authorize" 버튼 클릭하여 저장
  5. "Close" 버튼으로 모달 닫기

3. API 테스트

  1. 원하는 엔드포인트 섹션 확장
  2. "Try it out" 버튼 클릭
  3. 필요한 파라미터 입력
  4. "Execute" 버튼 클릭
  5. 응답 결과 확인

🔑 API 주요 엔드포인트

  • 계정 관리 (Accounts)
    POST https://rankly.kr/api/v1/accounts/login/ - 로그인
    POST https://rankly.kr/api/v1/accounts/signup/ - 회원가입
  • 슬롯 관리 (Slots)
    GET https://rankly.kr/api/v1/accounts/{user_id}/slots/ - 슬롯 목록 조회
    POST https://rankly.kr/api/v1/accounts/{user_id}/slots/ - 슬롯 생성
  • 랭킹 조회 (Rank)
    GET https://rankly.kr/api/v1/slots/rank/ - 랭킹 데이터 조회
  • 정산 (Invoice)
    GET https://rankly.kr/api/v1/invoice/ - 정산 내역 조회
  • 구독 (Subscriptions)
    GET https://rankly.kr/api/v1/subscriptions/ - 구독 정보 조회
  • 게시판 (Boards)
    GET https://rankly.kr/api/v1/boards/ - 게시글 목록
    GET https://rankly.kr/api/v1/boards/banners/ - 배너 목록

🔐 인증 방법

대부분의 API는 JWT 토큰 기반 인증이 필요합니다. 로그인 API를 통해 access 토큰을 받은 후, 모든 요청의 Authorization 헤더에 Bearer {token} 형식으로 포함해야 합니다.

예시:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...

Rankly API v0.1 | Powered by Django & Django Ninja

API Base URL: https://rankly.kr/api/v1

🌐 rankly.kr | 📧 admin@rankly.kr