Menu

    直接リンクAPIドキュメント

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

    概要

    Secure Code WarriorDirect Linking APIはRESTfulなJSONサービスで、パートナーがアプリケーション・セキュリティ・トレーニング教材を取得できるように します。利用可能な教材には、50以上の言語とフレームワークの説明ビデオとトレーニング演習へのリンクが含まれ、すべてパートナー製品内からコンテキストに関連したマイクロラーニングの機会を開発者に提供するように設計されています。

    APIは、パートナー製品で利用できるように設計されており、アプリケーション・セキュリティ・トレーニング教材へのアクセスを提供し、製品にリンクしたり、製品に組み込んだりすることができる。このAPIは、CWEやOWASPといった業界標準の脆弱性リファレンスの範囲をサポートし、パートナー製品が演習コンテンツの言語とフレームワークを指定することもできる。

    Direct Linking APIは、弊社の[利用規約]に従ってご利用ください。

    設定

    APIを呼び出すには、パートナーIDが必要です。パートナーIDは、パートナーシップチームのメンバーから提供されます。まだお受け取りになっていない場合は、弊社までご連絡ください。

    また、あなたの脆弱性カテゴリーを私たちのカテゴリーにマッピングする必要があります。カテゴリーをマッピングする最も簡単な方法は、CWEやOWASPリファレンスなどの業界標準を使用することです。すでに脆弱性カテゴリーをこれらにマッピングしている場合は、カスタムマッピングを作成する必要はありません。有効なマッピングはAPI自体から取得できます[ここ]。しかし、カスタマイズされたより正確なマッピングをご希望の場合は、パートナーシップ・チームにご連絡ください。

    最後に、あなたの開発言語とフレームワークを私たちのものにマッピングする必要があります。Direct Linking API で有効な言語とフレームワークのキーは、API 自体から取得できます[こちら]。言語とフレームワークを対応する LanguageKey にマッピングすれば、必要な設定は完了です。

    使用方法

    Direct Linking API のエンドポイントは以下にあります：

    • https://integration-api.securecodewarrior.com/api/v1/trial

    以下のパラメータを指定してHTTP GETで呼び出すことができます：

    • Id - パートナー ID
    • MappingList - 使用するカスタムマッピングまたは脆弱性参照スキーム。
    • MappingKey - トレーニング資料を取得するためのマッピングまたは参照キー。
    • LanguageKey - トレーニング演習を取得する言語およびフレームワーク。

    例えば、以下の API 呼び出しは、Spring フレームワーク（LanguageKey java:spring）を使用した Java での SQL インジェクション（MappingList CWE および MappingKey 89）に関するトレーニング資料を含む JSON を返します：

    APIは、パートナー製品に埋め込むか、リンクとして追加できる以下のプロパティを含むJSONで応答します：

    • url - Secure Code Warrior プラットフォーム上のトレーニング演習へのリンク。
    • name - 脆弱性の表示名
    • description - 脆弱性の高度な説明。
    • videos - 脆弱性のトピックに関する関連説明ビデオへのリンクの配列です。

    MappingKey にトレーニング教材への有効なマッピングがない場合、404 not found エラーが返されます。この場合、パートナー製品はこのケースを処理し、トレーニング教材の表示を抑制することができます。

    はじめに

    Direct Linking API Center にアクセスして完全なリファレンス・ドキュメントを表示し、インタラクティブな API エクスプローラーにアクセスするには、次のリンクをクリックしてください。 [ここ]をクリックしてください。

    ブラウザ・クライアント・ライブラリ

    任意の Web フロントエンドで使用できるシンプルなブラウザクライアントライブラリが用意されており、Direct Linking API の呼び出し方法の実装例として使用できます：

    次のスクリーンショットは、架空の静的解析セキュリティスキャナのレポート例を示しています。青くハイライトされた部分は、スキャナによって生成されたレポートに説明ビデオ、テキスト説明、文脈トレーニングボタンを直接埋め込むために、CWE参照に基づいてDirect Linking APIから動的に入力されたものです。ライブのレポート例を見る[こちら]。

    mceclip0.png

    関連記事

    コメント

    0件のコメント

    記事コメントは受け付けていません。