API 빠른 시작

Deeply API Documentation

Deeply API는 중앙 서버와 연동하기 위한 REST API와 실시간 이벤트용 WebSocket 인터페이스를 제공합니다. 처음 시작한다면 아래 3단계를 먼저 완료하는 것이 가장 빠릅니다.

1. API Key 준비#

• API Key: Access Token 발급에 사용하는 장기 자격 증명
• Access Token: 일반 API 요청에 사용하는 Bearer 토큰

키 발급이 아직 준비되지 않았다면 contact@deeplyinc.com으로 문의해 주세요.

2. Access Token 발급#

API Key를 사용해 Access Token을 발급한 뒤, 일반 API 요청에는 Access Token만 사용합니다.

const response = await fetch('http://{{EDGE_IP}}:8100/api/v1/auth/reissue', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

const data = await response.json();

3. 첫 요청 보내기#

토큰 발급이 끝났다면 이벤트 목록 조회로 첫 요청을 바로 확인할 수 있습니다.

const response = await fetch('http://{{EDGE_IP}}:8100/api/v1/events?page=1&size=10', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

const data = await response.json();

기본 URL#

모든 REST API 요청은 기본적으로 아래 로컬 기본 URL을 사용합니다.

http://{{EDGE_IP}}:8100

공개 HTTPS 환경을 검증해야 한다면 https://openapi.deeplyinc.com에서도 테스트할 수 있습니다.

공개 HTTPS 테스트 요구 사항#

아래 항목은 https://openapi.deeplyinc.com로 테스트할 때 필요합니다:

• TLS 1.2 이상을 지원하는 HTTPS 연결
• 표준 포트 443
• DNS 캐시 TTL 300초
• API Key

방화벽 및 프록시를 사용하는 경우 https://openapi.deeplyinc.com 테스트 기준으로 다음을 확인해 주세요:

• 포트 443에 대한 아웃바운드 HTTPS 트래픽 허용
• https://openapi.deeplyinc.com를 허용 목록에 추가하거나 모든 공인 IP 접근 허용

참고: DNS 캐시를 올바르게 설정하면 오래된 IP 주소로 요청이 전송되는 문제를 줄일 수 있습니다.

요청 헤더#

일반 API 요청에는 다음 헤더를 포함하세요.

• Content-Type: application/json; charset=utf-8
• Authorization: Bearer YOUR_ACCESS_TOKEN

Access Token 발급 전용 요청에는 Authorization: Bearer YOUR_API_KEY를 사용합니다.

다음에 볼 문서#

• 인증: API Key와 Access Token 역할 구분
• 호출 제한: 운영 전 확인해야 할 요청 한도
• 이벤트 목록 조회: 첫 요청에 가장 적합한 엔드포인트
• 실시간 이벤트 수신: WebSocket으로 실시간 데이터 수신

Postman으로 바로 시작하기#

Postman은 API 호출을 단순화해 주는 API 클라이언트입니다. Deeply 연동을 쉽게 시작할 수 있도록 Postman Collection을 제공합니다. 컬렉션을 포크한 뒤 api_key 환경 변수에 발급받은 API Key를 입력하면 주요 요청을 바로 테스트할 수 있습니다.