API リファレンス

認証とトークン

デバイスのログインとトークン。ログイン後の token と c-id は、同じセッションに属している必要があります。

デバイスのログイン手順

クライアント
https://<host>:<port>/init
サーバー

POST /init

HTTP request

c-id: clientId · body: empty

フィールドにカーソルを合わせるかタップしてください
1 / 7

sessionKey = Base64Decode(token)。ログイン時に両側で導出し、Bearer として送らない。logout または revokeSession で失効。パスワード変更だけでは失効しない。

端末アプリの接続 → API トークンで作成し、clientId と token を一緒にコピー。削除すると失効する。Bearer は HTTPS のみで送信。

HTTP 本文の暗号化ではダウンロードしたページのコードを保護できない。初回は信頼できるサーバー識別情報が必要。ブラウザーでは信頼できる HTTPS を使う。

未認証の接続が多すぎる場合、サーバーは WebSocket にアップグレードする前に、本文が空の HTTP 429 を返します。しばらくしてから再試行してください。

WebSocket /auth · AuthErrorCode · エラー

最初のフレーム:10 秒。有効な最初のフレーム後、60 秒以内にハンドシェイク完了。ログインと承認は合計 300 秒。

INVALID_LOGIN_REQUEST
ログイン要求を確認し、新しいハンドシェイクを開始してください。
PASSWORD_SETUP_REQUIRED
先にデバイスでログインパスワードを設定してください。
INVALID_PASSWORD
パスワードを確認して再試行してください。
PEER_IDENTITY_CHANGED
続行する前にデバイスの識別情報を確認してください。
REMOTE_ACCESS_DISABLED
デバイスでリモートアクセスを有効にしてください。
REJECTED
デバイスの所有者がログインを拒否しました。
TIMEOUT
ログインを再度要求してください。
TOO_MANY_LOGIN_ATTEMPTS
しばらく待ってから再試行してください。

操作

http

Bearer API トークン

独立した API Token を使い、本文を暗号化せずに HTTPS 経由で JSON を送信します。

bash
curl --request POST \
  --url 'https://<device-host>:<https-port>/graphql' \
  --header 'c-id: <client-id>' \
  --header 'Authorization: Bearer <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"{ app { deviceName capabilities access } }"}'
mutation

logout

呼び出し元クライアントの現在の認証済みセッションを失効させます。

graphql
mutation logout {
  logout
}