メインコンテンツへスキップ

​
はじめに

OneS1ghtは、別途の開発なしに自社運営サービスのデータを安全に接続し、独自の分析モデルを通じて革新的なマーケティング戦略を得られるようOpen APIを提供しています。 Web、モバイルアプリケーション（iOS / Android）、POSなど、さまざまなプラットフォームに対応しています。

​
Base URL

https://api.ones1ght.com
すべてのエンドポイントは上記のBase URLを基準とします。 例：https://api.ones1ght.com/v1/profile

​
APIキー

キータイププレフィックス用途
Client SDKosk_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

​
推薦 (非同期 + ポーリング)

機能説明エンドポイント
推薦 kickofffire-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[] 1 項目の表示 / タップPOST /v1/chat/{profile_id}/trigger/recommend
詳細は プロフィールチャット ページをご覧ください。

​
認証方式

すべてのOpen APIリクエストには Authorization: Bearer {API_KEY} ヘッダーが必要です。 詳細は認証ページをご覧ください。

​
モデル分離

Open APIで使用するAIモデルはテナントチャットモデルとは別々に管理されます。 管理画面で Open API タイプのモデルを作成すると、外部アプリからのみ利用できます。