#19 Web API を使えるようにしています

icon Koda was written at Jun 24, 2017 3:15 PM ( icon Koda was updated at Jan 16, 2018 9:24 AM <History> )
  Edit(Sign in)
  Stock
  Answer survey   Answer survey

  TOC

Knowledge と他のシステムを簡単に連携することができるように、WebAPIを開発しています。
動かすことができるようになったため、テストサイトにデプロイしました。
興味のあるかたは、使ってみてご意見をください。

使い方

  • ログインしメニューを開くと、Access token のメニューを追加しています
  • Access tokenを発行します
  • 発行したAccess tokenで WebAPIにアクセスします
    • private_token のパラメータか、 PRIVATE-TOKEN をHttpHeaderに指定してアクセスします
  • Access tokenはユーザ毎に発行し、そのユーザの権限で動きます
    • 例えば記事の取得APIで、アクセスできない記事であると 403 エラーになります
    • 全ての記事にアクセスする場合、管理者権限を持つユーザで Access token を発行します

現在利用可能なAPI

  • 'GET' /api/knowledges
    • 登録されている記事の一覧を取得
  • 'GET'/api/knowledges/{:knowledgeId}
    • 登録されている記事の詳細を取得
  • 'GET' /api/users
    • ユーザ一覧を取得
  • 'GET'/api/users/{:userId}
    • ユーザの詳細を取得
  • 'GET' /api/groups
    • グループ一覧を取得
  • 'GET'/api/groups/{:groupId}
    • グループの詳細を取得
  • 'GET'/api/groups/{:groupId}/users
    • 指定のグループに所属するユーザの一覧を取得
  • 'GET'/api/groups/{:groupId}/knowledges
    • 指定のグループを公開範囲に指定した記事の一覧を取得

検討事項

  • Access Tokenの指定は、クエリパラメータでも指定可能にしたけど、ブラウザで確認したときなど「履歴」に入ってしまってセキュアで無い気がする
    • Http header の指定だけにした方が良いか?
  • 今後追加するAPIは以下と考えているけど足りるか?

今後追加予定のAPI

  • 'POST' /api/knowledges
    • 記事の投稿
  • 'PUT' /api/knowledges/{:knowledgeId}
    • 記事の更新
  • 'DELETE' /api/knowledges/{:knowledgeId}
    • 記事の削除
  • 'GET' /api/attch/{:fileId}
    • 添付ファイルの取得

いったん、上記まで出来たら、プレリリースを出そうかと思う

  • 'GET'/api/knowledges/{:knowledgeId}/survey
    • 記事のアンケートの回答(集計できるように)
  • 'GET'/api/knowledges/{:knowledgeId}/event
    • イベントの参加者の一覧

 Attach Files     - [0]


 Comment
[Registration] Jul 1, 2017 1:57 PM [Koda]
icon
  • 'POST' /api/knowledges
    • 記事の投稿
  • 'PUT' /api/knowledges/{:knowledgeId}
    • 記事の更新
  • 'DELETE' /api/knowledges/{:knowledgeId}
    • 記事の削除

ができた。


 Like! × 2  
Collapsed
[Registration] Jul 2, 2017 7:59 AM [Koda]
icon
  • 'GET' /api/attachments/{:fileId}

    • 添付ファイルの取得
  • 'attch' は 'attachments' で作成


 Like! × 0  
Collapsed



 Add Comment