API の使用

IBM® NS1 Connect® APIは、JSONレスポンスによる標準的なREST APIである。

APIファーストのアーキテクチャで構築された NS1 Connect プラットフォームは、 NS1 Connect アカウントとリソースをプログラムで管理するために必要なすべてのツールを提供します。 APIエンドポイントとリクエストの完全なインデックスについては、 NS1 Connect APIドキュメントを参照してください。

HTTP リクエスト方法

HTTP リクエストの方法によって、APIが実行するアクションの種類が決まります。通常、 PUT および POST リクエストの場合、作成または更新するリソースの詳細情報をJSON形式でリクエストのボディに送信します。

GET: このメソッドは、指定されたリソースの表現を要求します。 GET を使用するリクエストは、指定されたデータセットの一部を取得します。
PUT: このメソッドは、指定されたリソースにエンティティを送信します。通常は、新しいオブジェクトの作成です。
POST: この方法では、リクエストペイロードでターゲットリソースの現在の表現をすべて置き換えます。つまり、既存のリソースを編集または更新する。
DELETE: この方法では、指定されたリソースまたは構成を削除します。

認証

NS1 Connect APIは、リクエストの認証にAPIキーを使用する。最初のAPIキーは、 NS1 Connect UIから必要な権限で作成できます。

注意： APIキーシークレットを誰とも共有しないでください。また、APIキーシークレットは安全に保管してください。 APIキーを作成する際には、その用途に必要な権限のみを有効にしてください。

APIドキュメントでは、 "X-NSONE-Key: $NSONE_API_KEY" はAPI認証ヘッダーを表し、 $NSONE_API_KEY は有効な NS1 Connect APIキーの秘密である。 APIキーを環境変数の1つとして追加すると、コードスニペットをコピー＆ペーストしやすくなります。

注： NS1 Connect API リクエストは、 HTTPS で行う必要がある。認証されていないAPIコールや、プレーンな HTTP。