API

OpsIQ APIの機能とSDKリファレンスについて学ぶ

OpsIQ APIは冪等性をサポートしていますか?
はい、開発者モデルには冪等リプレイ保護が書き込み用に含まれています。この機能には、サポートされている操作のための文書化された24時間の冪等性ウィンドウが含まれています。クライアントは、ネットワーク障害後に同じ意図された書き込みを再試行する際に、同じキーを再利用する必要があります。真に新しい操作の場合は、新しいキーを作成する必要があります。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ…
2,886
OpsIQのアウトバウンドウェブフックはどのように署名されますか?
OpsIQは生のリクエストボディ上でHMAC-SHA256を使用してアウトバウンドウェブフックペイロードに署名します。また、タイムスタンプやイベントなどの配信メタデータも含まれています。受信者は次の手順に従うべきです: 正確な生のボディから署名を計算します。 計算された署名を定数時間で比較します。 タイムスタンプを検証します。 繰り返しの配信を冪等に処理します。 関連する記事 署名されたWebhooksとAPIアクションによる自動化…
2,871
OpsIQ一般APIを通じて利用可能な操作は何件ですか?
現在の開発者および統合ページは、1,558件の一般API操作を説明しており、62の最小特権スコープによって管理されています。操作レジストリは、APIの動作、アクションのドキュメント、スコープ、および検証が一貫していることを保証します。統合は、実際に必要な操作のみを呼び出すべきです。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ OpsIQドキュメントと開発者ドキュメント — OpsIQ…
2,856
OpsIQ APIはドライランリクエストをサポートしていますか?
はい、OpsIQ APIはドライランリクエストをサポートしています。サポートされている操作はdry_runの動作を利用でき、統合者は書き込みを確定することなく意図とパラメータを検証できます。この機能は特に高影響の自動化やテストに役立ちます。ただし、ドライランはステージングの代わりにはならないことに注意が必要です。すべての外部副作用を安全に再現できるわけではありません。 関連する記事 開発者API、Webhookおよびコネクタビルダー…
2,819
OpsIQはどのSDKおよびAPIリファレンス形式を提供していますか?
OpsIQはOpenAPI 3.0.3の説明、Postmanリソース、およびPHP、Node.js、およびPythonのためのヘルパーパターンを提供します。これにより、チームは単一の独自SDKに依存するのではなく、好みの技術スタックと統合することができます。ただし、生成されたクライアントの秘密情報の取り扱いやタイムアウト、リトライ、冪等性などの側面を確認することが重要です。 関連する記事…
2,654
API トークンを削除せずに一時的に無効にすることはできますか?
はい、API トークンはトークンを無効にし、後で再度有効にすることをサポートしています。統合が一時的にそれを使用しなくなるべきときにトークンを無効にできます。トークンが無効になっている間、接続された統合は認証に失敗することを忘れないでください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,560
OpsIQにおけるAPIレート制限はどのように機能しますか?
OpsIQはキーごとにAPIレート制限を適用し、レスポンスヘッダーにレート制限情報を返します。制限を超えた場合、クライアントはHTTP 429ステータスコードと、Retry-Afterヘッダーを通じて再試行のタイミングに関するガイダンスを受け取ります。 統合は、すぐに再試行するのではなく、バックオフ戦略を実装するべきです。プランの制限はキー、アクション、ウェブフック、統合、およびトリガーに対して別々に適用されることを覚えておくことが重要…
2,540
API トークンについてどのような情報を見ることができますか?
API トークン ページは、各トークンに関するさまざまな詳細を提供します。包括的に: トークン名 公開識別子 付与された権限 現在のステータス 使用情報(例:最後に使用された時期) 作成後、秘密自体は再表示されないことに注意してください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか? OpsIQ一般APIを通じて利用可能な操作はどれくらいですか?…
2,483
なぜ再度私のAPIトークンの秘密を見ることができないのですか?
トークンの秘密は、作成時にのみ意図的に表示されます。アカウントは、後で表示するための再利用可能な平文コピーではなく、将来のトークン使用を確認するために必要なものを保存します。秘密を失った場合は、交換用のトークンを作成し、失われたトークンを無効にするか削除する必要があります。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,461
OpsIQ一般APIにどのように認証しますか?
OpsIQ一般APIへの認証 OpsIQの一般APIはスコープ付きBearer APIキーを利用します。これらのキーは、その機能に必要な最小限の権限スコープのみが割り当てられることが重要です。さらに、これらは秘密として安全に保存され、公開ブラウザコードやリポジトリに含めるべきではありません。 開発者サイトは以下の詳細情報を提供します: 62の利用可能なスコープ 一般的なAPIエントリポイント レート制限ヘッダー 安定した運用契約…
2,406
API トークンを削除するとどうなりますか?
トークンを削除すると、その顧客トークンがアクティブな使用から永久に削除されます。それにまだ設定されている統合は認証を停止し、アクセスが必要な場合は新しいトークンで更新する必要があります。永久的な削除の代わりに可逆的な一時停止を希望する場合は、まずトークンを無効にしてください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,392
OpsIQにおける顧客APIトークンとは何ですか?
顧客APIトークンは、アカウントのパスワードを共有することなく、サポートされている顧客スコープの統合を認証することを可能にします。これらのトークンは、トークンが作成される際に提供されるスコープに応じて、サポートされているアカウント、ライセンス、請求、またはサポート操作に対する制限された権限を持つことができます。統合には、実際に必要な権限のみを付与することが重要です。 関連する記事…
2,370
OpsIQ 顧客 API トークンを作成するにはどうすればよいですか?
OpsIQ 顧客 API トークンを作成するには、次の手順に従ってください: API トークンセクションを開きます。 説明的な名前でトークンを作成します。 適切な利用可能な権限を選択します。 トークンが作成されたら、秘密をすぐにコピーして安全に保管してください。完全な秘密は一度だけ表示されます。OpsIQ は検証目的のために保護された表現を保持し、元の秘密を後で再表示することはありません。 関連する記事…
2,314
統合のために、アカウントパスワードの代わりにOpsIQ APIトークンを使用できますか?
はい、サポートされている顧客API操作のために、アカウントパスワードの代わりにOpsIQ APIトークンを使用できます。この方法は、インタラクティブアカウントパスワードとの統合を提供するよりも好ましいです。なぜなら、トークンは名前を付けたり、スコープを設定したり、監視したり、無効にしたり、独立して置き換えたりできるからです。トークンを秘密に保ち、ブラウザのURL、チケット、ログに含めないようにすることが重要です。 関連する記事…
1,951
まだヘルプが必要ですか?

お探しのものが見つからない場合は、私たちのチームがここにいます。

サポートに連絡