qnypのデータを利用するためのAPIとして qnyp GraphQL API を公開しました(以下 GraphQL API)。
APIでできること 🤔
現時点で、 GraphQL API では以下のようなことが可能です。
- タイトル、エピソード、ユーザー、視聴ログの取得
- 視聴ログとは「ユーザーが作成したエピソードに対する視聴の記録および感想」を指します
- 視聴ログの作成・編集・削除
また、 OAuth 2.0 による権限認可の仕組みも用意してありますので、qnypユーザーの認可を得てユーザーのかわりに GraphQL API を操作するようなWebアプリケーションやクライアントアプリなどを開発することも可能です。
APIを試す 🔧
プログラミングを行うことなく GraphQL API を簡単に試せるように qnyp GraphQL Explorer というアプリケーションを用意してあります。
上の画像のように、GraphQL Explorer にアクセスして自分のqnypアカウントの権限を与えることで、ブラウザ上でドキュメントを参照しながら実際のAPIを操作することができます。
サンプルコード 💎
実際にプログラム内から GraphQL API を呼び出すコードの例として qnyp/qnyp-graphql-example-ruby にRubyのサンプルを用意してあります。このサンプルはクライアントライブラリとして github/graphql-client を利用したCLIアプリケーションとなっています。
ドキュメント 📖
GraphQL API および OAuth 2.0 を使ったアプリケーション開発の詳細については qnyp GraphQL API Reference にあるドキュメントを参照してください。
質問や要望などがありましたら qnyp/developer.qnyp.com リポジトリの Issue までどうぞ 👋
今後は、順次GraphQL APIで取得できるデータの種類を拡充しつつ、ユーザーの皆さんにqnyp上の各種データを追加・更新していただける仕組みを整備していく予定です。