Open API 개요 - OneSight

소개

OneS1ght는 별도의 개발 없이 자체 운영되는 서비스의 데이터를 안전하게 연결하고 자체 분석 모델을 통해 혁신적인 마케팅 전략을 얻을 수 있도록 Open API를 제공하고 있습니다. 웹, 앱 어플리케이션 (iOS / Android), POS 등 다양한 플랫폼을 지원합니다.

Base URL

https://api.ones1ght.com

모든 엔드포인트는 위 Base URL을 기준으로 합니다. 예: https://api.ones1ght.com/v1/profile

API 키

키 타입	접두사	용도
Client SDK	`osk_`	iOS, Android, Web 어플리케이션에서 사용되는 API 키이며 개인별 데이터 통신을 위해 사용합니다.

자세한 발급/관리 방법은 인증 페이지를 참조하세요.

공통 API

기능	설명	엔드포인트	링크
API 키 유효성 확인	키 상태/만료/타입 확인	`GET /v1/validation`	문서

Client SDK API

프로필 기반 대화형 AI 엔드포인트입니다.

프로필 관리

기능	설명	엔드포인트
프로필 등록	AI 개인화를 위한 프로필 생성	`POST /v1/profile`
프로필 조회	프로필 정보 조회	`GET /v1/profile/{profile_id}`
프로필 수정	프로필 정보 수정	`PUT /v1/profile/{profile_id}`
프로필 삭제	프로필 삭제	`DELETE /v1/profile/{profile_id}`
프로필 이벤트 조회	해당 프로필에 누적된 SDK 이벤트 조회	`GET /v1/profile/{profile_id}/events`

추천 (비동기 + 폴링)

기능	설명	엔드포인트
추천 요청	추천 kickoff (fire-and-forget, ~100ms 즉시 응답)	`POST /v1/chat/{profile_id}/recommend`
채팅 리스트	누적된 chat 페이징 조회	`GET /v1/chat/{profile_id}/recommend`
채팅 디테일	폴링 진입점 — rounds[] 와 함께 반환	`GET /v1/chat/{profile_id}/recommend/{chat_id}`
단일 라운드 조회	라운드 1개만 조회	`GET /v1/chat/{profile_id}/recommend/{chat_id}/{round_id}`
바코드 모음	라운드 내 product 들의 EAN-13 PNG (base64)	`GET /v1/chat/{profile_id}/recommend/{chat_id}/{round_id}/barcodes`

트리거 (이벤트 송신)

기능	설명	엔드포인트
사이니지 ads 트리거	사이니지 진입/이탈 (`action: enter` / `exit`)	`POST /v1/chat/{profile_id}/trigger/signage`
쿠폰 발급/사용	쿠폰 발급/사용/거절 로그	`POST /v1/chat/{profile_id}/trigger/coupon`
개인 추천 노출 로그	`recommended_items[]` 한 항목 노출/탭 로그	`POST /v1/chat/{profile_id}/trigger/recommend`

자세한 내용은 프로필 채팅 페이지를 참조하세요.

인증 방식

모든 Open API 요청에는 Authorization: Bearer {API_KEY} 헤더가 필요합니다. 자세한 내용은 인증 페이지를 참조하세요.

모델 분리

Open API에서 사용하는 AI 모델은 테넌트 채팅 모델과 별도로 관리됩니다. 어드민에서 Open API 타입으로 모델을 생성하면 외부 앱에서만 사용할 수 있습니다.

​소개

​Base URL

​API 키

​공통 API

​Client SDK API

​프로필 관리

​추천 (비동기 + 폴링)

​트리거 (이벤트 송신)

​인증 방식

​모델 분리

소개