APIサーバの使い方

ここではAPIサーバの使い方について説明します。

APIサーバの詳しい使い方についてはAPIドキュメントページを参照ください。

  1. 概要
    • APIサーバにはHTTPで接続します。
    • エンドポイントは ninigi.omoikanet.org/1 になります。
    • リクエストの内容に応じて、URL、リクエストボディ、メソッドを適宜指定して接続します。
    • レスポンスはJSON形式のテキストデータになります。
    • APIサーバの各機能を利用するためには、最初にアクセストークンを取得する必要があります。
    • 権限の無い情報の取得や登録は行なえません。
  2. 機能
    1. OAuth API
      • token
        アクセストークンの取得
    2. Util API
      • my_serial
        保有するシリアルの一覧の取得
      • my_products
        所有するプロダクトの一覧の取得
      • whoami
        自分自身の情報の取得
      • login_name_is_exists
        ログイン名の重複の確認
    3. Message API
      • list
        メッセージを取得
    4. Serial API
      • /
        シリアル情報の取得
      • list
        シリアル情報の一覧の取得
      • create
        シリアル情報の新規作成
      • update
        シリアル情報の更新
      • regist
        シリアル情報とユーザ情報の紐付け
      • release
        シリアル情報とユーザ情報の紐付け解消
      • destroy
        シリアル情報の削除
    5. User API
      • /
        ユーザ情報の取得
      • list
        ユーザ情報の一覧の取得
      • create
        ユーザ情報の作成
      • update
        ユーザ情報の更新
      • destroy
        ユーザ情報の削除
    6. Vendor API
      • /
        ベンダ情報の取得
      • list
        ベンダ情報の一覧の取得
      • create
        ベンダ情報の作成
      • update
        ベンダ情報の更新
      • destroy
        ベンダ情報の削除
    7. Product API
      • /
        プロダクト情報の取得
      • list
        プロダクト情報の一覧の取得
      • create
        プロダクト情報の作成
      • update
        プロダクト情報の更新
      • destroy
        プロダクト情報の削除
    8. Control API
      • /
        コントロール情報の取得
      • list
        コントロール情報の一覧の取得
      • create
        コントロール情報の削除
      • update
        コントロール情報の更新
      • destroy
        コントロール情報の削除
    9. Notification API
      • /
        お知らせ情報の取得
      • list
        お知らせ情報の一覧の取得
      • create
        お知らせ情報の作成
      • update
        お知らせ情報の更新
      • destroy
        お知らせ情報の削除
    10. Message Type API
      • list
        メッセージタイプの一覧の取得
      • create
        メッセージタイプの作成
      • update
        メッセージタイプの更新
      • destroy
        メッセージタイプの削除