Menu

    GraphQLによるレポートAPI

    Avatar
    Secure Code Warrior Elves
    • 更新
    フォローする

    Secure Code Warriorは、クライアント・アプリケーション（通常はビジネス・インテリジェンス・ツールやプラットフォーム）を介して企業のデータにアクセスできるようにするためのAPIスイートを提供します。

    新しいReporting APIは、GraphQLを採用しており、REST APIのエンドポイントとは異なる形式でデータを照会します。

    注： 既存の REST API の既存のデータや機能がすべて新しい API に複製されるわけではありません。お探しのデータに最適なクエリやエンドポイントが不明な場合は、サポートチーム までお問い合わせください！

    APIキーの生成

    SCW の REST API 用に設定したのと同じ API キー（読み取り専用の Reporting API キー、または読み取り/書き込み可能な Management API キー）が Reporting API でも使用できます。唯一の違いは、ヘッダが以下の形式である必要があるということです。

    {

     "Authorization"："Bearer<< YOUR-SCW-API-KEY-HERE>> "

     }.

    SCW での API キーの作成および失効方法の詳細については、API アクセスを有効にする方法 を参照してください。


    レポート API ドキュメント

    Reporting API Explorer および詳細なドキュメントは以下のリンクから入手できます：

    Secure Code Warrior Reporting APIを調べる


    以下のステップに従って開始してください。

    ステップ1

    上記のリンク（）を使用してQuery Explorerに移動します。

    ステップ2

    ヘッダー」セクションにAPIキーを追加します。


    GraphQL-Step1.png


    ステップ3

    左上の📔アイコンをクリックして、スキーマ・ドキュメントに従ってください。


    GraphQL-Step2.png



    ステップ4

    中央のビューポートにGraphQLクエリーを書いて試してみましょう。覚えておくべき重要なことが2つあります：

    • クエリを中括弧{}で囲む。
    • APIが返したいフィールドを指定する。

    GraphQLを初めて使用する場合は、こちらの記事 、最初のGraphQLクエリを書くための初心者向けガイドをご覧ください。

    GraphQL-Step4.png


    ステップ5

    クエリーを実行します。右側に結果が表示されます。

    GraphQL-Step5.png



    注： Reporting APIでは、Relayが提供するページ分割スタイルを使用しています（https://relay.dev/graphql/connections.htm ）。各クエリは'edge'と'pageInfo'を持つオブジェクトを返します。クエリの対象となるデータは、'edges' オブジェクトの中に、データを保持する 'nodes' の配列としてネストされます。pageInfo'オブジェクトには、次のページがあるかどうかと、それを取得するためのカーソルが含まれます。


    クエリを作成するのに役立つGraphQLクライアントアプリケーションをいくつか紹介します：


    便利なリンク

    関連記事

    コメント

    0件のコメント

    サインインしてコメントを残してください。