開発者ドキュメント

開発者リソースとAPIドキュメントを見つける

カテゴリ別にブラウズ 5 サブカテゴリ
50 記事 · このセクションで
開発者API、Webhookおよびコネクタビルダー — OpsIQ
OpsIQは、開発者API、Webhook、およびコネクタビルダーを通じて、ガバナンスされた統合を構築するための堅牢なプラットフォームを提供します。これにより、開発者はセキュリティと信頼性に重点を置いたAI操作可能なアプリケーションを作成できます。 主な機能 スコープ付きベアラキー: 統合が必要な権限のみを持つことを保証するために、最小特権アクセスを持つAPIキーを生成します。契約生成アクション…
3,104
Remote SitesはOpsIQに販売転換を報告できますか?
はい、Remote Sitesは販売転換ブリッジパターンをサポートしており、購入やその他の結果を正しいサイトとジャーニーに帰属させることができます。テンプレートはWooCommerceやカスタムPHPなどの環境用に提供されています。さらに、Sales Bridgeは正規化されたinvoice.paid-スタイルのイベントを受け入れることができます。金額はサーバーサイドのコマースまたは請求確認から発生する必要があります。 関連する記事…
3,000
ポータルスタジオ管理者および開発者ガイド — OpsIQ
概要 OpsIQポータルスタジオは、エンタープライズ顧客ポータルを構築、プレビュー、管理、公開、拡張することを可能にします。このガイドは、管理者と開発者の両方がポータルスタジオを効果的に利用するための重要な情報を提供します。 主な機能 大胆に構築し、安全に公開する: スタジオが所有するものを理解し、深い構築の前に準備を整えます。ページとコンポーネント管理…
2,999
OpsIQにはどれくらいの統合およびコネクタ機能がありますか?
OpsIQの統合およびコネクタ機能 現在の統合制御プレーンは次のことを報告しています: 23 バンドルパッケージ 21 マーケットプレイスエントリ 52 機能タイプ 7 スタートプロファイル 1,558 一般APIアクション リリース状態が重要であることに注意することが重要です。同じページは、バンドルされた一般提供(GA)パッケージ、バンドルされたプレビューパッケージ、およびマーケットプレイスパッケージの間で区別し、それぞれに特定の契約…
2,996
OpsIQには標準的なアウトバウンドWebhookイベントがいくつありますか?
OpsIQにおける標準的なアウトバウンドWebhookイベント Webhookおよびアクションページでは、合計の30の標準的なアウトバウンドイベントと、ワイルドカードサブスクリプションの機能について説明しています。エンドポイントは、必要なイベントにサブスクライブし、必要に応じてフィルターを適用できます。この標準的なモデルは、各コネクタが同じプラットフォームイベントの異なる表現を作成する必要性を減少させます。 関連する記事…
2,993
OpsIQのウェブフック再試行スケジュールは何ですか?
最初のウェブフック配信が失敗した後、文書化された再試行シーケンスは次のとおりです: 1分 5分 30分 2時間 12時間 6回目の合計試行後、配信は失敗としてマークされます。配信履歴は、診断のためのステータス、試行、および応答情報を記録します。 関連する記事 署名されたWebhooksとAPIアクションによる自動化 — OpsIQ 統合、API & コネクタビルダー — OpsIQ…
2,953
統合、API & コネクタビルダー — OpsIQ
OpsIQは、管理されたパッケージ、API、および署名されたウェブフックを通じてさまざまなシステムを統合するための堅牢なプラットフォームを提供します。ユーザーは、OpsIQマーケットプレイスを介してコネクタを構築、公開、販売することもできます。統合プロセスは、承認されたアクションを効率的に送信しながら、システムにコンテキストを持ち込むように設計されています。 主な機能: 統合コントロールプレーン…
2,937
OpsIQ コネクタ機能タイプとプロファイルとは何ですか?
OpsIQ コネクタ機能タイプとプロファイル 統合制御プレーンは現在、52 機能タイプと7 スタートプロファイルを説明しています。プロファイルは、次のような一般的なプラットフォームの形状を表します: 標準 API コマース ヘルプデスク メールボックス サイトインテリジェンス 顧客プラットフォーム ローカルプラットフォーム…
2,904
OpsIQのセルフホステッドソフトウェアをダウンロードできるのは誰ですか?
ダウンロードは、ダウンロードが有効で、関連するサブスクリプションまたはトライアルがアクティブな場合、対象となるセルフホステッド顧客に提供されます。クラウド専用の顧客は、通常、セルフホステッドアプリケーションをダウンロードする代わりに、プロビジョニングされたワークスペースを使用します。 どのプランがセルフホステッドにできますか?…
2,891
OpsIQ APIは冪等性をサポートしていますか?
はい、開発者モデルには冪等リプレイ保護が書き込み用に含まれています。この機能には、サポートされている操作のための文書化された24時間の冪等性ウィンドウが含まれています。クライアントは、ネットワーク障害後に同じ意図された書き込みを再試行する際に、同じキーを再利用する必要があります。真に新しい操作の場合は、新しいキーを作成する必要があります。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ…
2,890
OpsIQのアウトバウンドウェブフックはどのように署名されますか?
OpsIQは生のリクエストボディ上でHMAC-SHA256を使用してアウトバウンドウェブフックペイロードに署名します。また、タイムスタンプやイベントなどの配信メタデータも含まれています。受信者は次の手順に従うべきです: 正確な生のボディから署名を計算します。 計算された署名を定数時間で比較します。 タイムスタンプを検証します。 繰り返しの配信を冪等に処理します。 関連する記事 署名されたWebhooksとAPIアクションによる自動化…
2,872
複数のRemote Sitesをグループ化できますか?
はい、Remote Sitesはグループアイデンティティを持つことができ、これによりマルチブランドまたはエージェンシーのワークスペースが関連するサイトを整理しながらサイトレベルのスコープを保持します。グループはナビゲーションとロールアップを改善しますが、すべてのアカウントマネージャーにすべてのサイトのデータへのアクセスを自動的に付与するわけではありません。 関連する記事 OpsIQにおけるリモートサイトとは何ですか?…
2,864
OpsIQ一般APIを通じて利用可能な操作は何件ですか?
現在の開発者および統合ページは、1,558件の一般API操作を説明しており、62の最小特権スコープによって管理されています。操作レジストリは、APIの動作、アクションのドキュメント、スコープ、および検証が一貫していることを保証します。統合は、実際に必要な操作のみを呼び出すべきです。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ OpsIQドキュメントと開発者ドキュメント — OpsIQ…
2,858
OpsIQ APIはドライランリクエストをサポートしていますか?
はい、OpsIQ APIはドライランリクエストをサポートしています。サポートされている操作はdry_runの動作を利用でき、統合者は書き込みを確定することなく意図とパラメータを検証できます。この機能は特に高影響の自動化やテストに役立ちます。ただし、ドライランはステージングの代わりにはならないことに注意が必要です。すべての外部副作用を安全に再現できるわけではありません。 関連する記事 開発者API、Webhookおよびコネクタビルダー…
2,821
OpsIQはカスタムバックエンドに接続できますか?
はい、OpsIQはカスタムバックエンドに接続できます。カスタムバックエンドは、一般API、ウェブフック、コネクタビルダー、または明示的なAIアクションエンドポイントを利用できます。アーキテクチャは、OpsIQが必要とするアイデンティティ、コンテキスト、イベント、およびアクションのみを公開する必要があります。統合の努力は、認証、データモデル、イベントソース、およびセキュリティ要件などの要因によって異なる場合があります。 関連する記事…
2,808
OpsIQはリモートHTTPアクションをSSRFからどのように保護しますか?
リモートアクションは宣言されたエンドポイントを利用し、サーバーサイドリクエストフォージェリ(SSRF)に対する保護を含みます。これらの保護は、ベアラー、APIキー、ベーシック、およびHMACを含むさまざまな認証オプションを提供します。 セキュリティを強化するために、管理者はこれらのベストプラクティスに従うべきです: 任意のユーザー制御URLを避ける。 宛先を制限する。 ホスト/IPの動作を検証する。 最小権限の資格情報を使用する。…
2,777
OpsIQコネクタビルダーはどのように機能しますか?
コネクタビルダーは、6つのガイド付きステージを使用します:アイデンティティ、認証、接続テスト、アクション、トリガー、およびレビュー。ビルダーは、OpenAPI、Postman、cURL、または選択したプロファイルから開始できます。 認証オプションには、 APIキー ベアラー ベーシック OAuth 2.0 HMAC カスタムパターン 結果のパッケージは、ランタイムバリデーションとドキュメントを提供します。 関連する記事…
2,776
すべての OpsIQ 統合が同じように利用可能ですか?
いいえ、すべての OpsIQ 統合が同じように利用可能なわけではありません。一部のコネクタは一般提供(GA)としてバンドルされている一方で、他のコネクタはプレビューとしてバンドルされています。さらに、マーケットプレイスパッケージには独自の準備状況がある場合があります。…
2,717
OpsIQはWHMCSと連携しますか?
はい、OpsIQはWHMCSと連携します。ホスティングとWHMCSは一流のソリューションパターンを形成します。WHMCSコネクタは、認証された顧客、サービス、請求書、ドメイン、注文、およびサポートコンテキストを提供し、チャット、CRM、チケット、またはAdmin AIに承認された操作を公開できます。高影響の変更は、制限のないデータベースアクセスを通じて実行されるのではなく、署名され、スコープが設定されるべきです。 関連する記事…
2,710
OpsIQに別のウェブサイトを追加するにはどうすればよいですか?
OpsIQに別のウェブサイトを追加するには、次の手順に従ってください: 次の設定でリモートサイトを作成します: ラベル ドメイン グループ トラッキング設定 ユニークなサイトキーを含む生成されたスニペットをインストールします。 期待されるビーコンまたは接続が受信されると、サイトがアクティブになります。 さらに、重複ドメイン防止とプライマリサイト保護が設定ミスを減らすために実施されています。 関連する記事…
2,692
Marketplaceのセキュリティスキャンは私のコネクタを拒否できますか?
はい、Marketplaceは提出されたコネクタパッケージに対して静的セキュリティチェックを実施します。重要な発見がある場合、パッケージは保留、拒否、またはさらなるレビューのために隔離されることがあります。特定された問題を修正し、スキャナーを回避しようとするのではなく、準拠したバージョンを提出することが重要です。 関連する記事 統合、API & コネクタビルダー — OpsIQ OpsIQコネクタビルダーはどのように機能しますか?…
2,673
OpsIQはどのSDKおよびAPIリファレンス形式を提供していますか?
OpsIQはOpenAPI 3.0.3の説明、Postmanリソース、およびPHP、Node.js、およびPythonのためのヘルパーパターンを提供します。これにより、チームは単一の独自SDKに依存するのではなく、好みの技術スタックと統合することができます。ただし、生成されたクライアントの秘密情報の取り扱いやタイムアウト、リトライ、冪等性などの側面を確認することが重要です。 関連する記事…
2,660
OpsIQ ドキュメント & 開発者ドキュメント — OpsIQ
OpsIQ ドキュメント & 開発者ドキュメントの概要 OpsIQは、ユーザーがそのプラットフォームを効果的に設定、運用、拡張するための包括的なドキュメントを提供します。これには、AIチャット、チケッティング、CRM、分析、REST APIエンドポイント、ウェブフック、コネクタSDKなどのさまざまな機能に関するガイダンスが含まれています。また、セルフホスティングデプロイメントのオプションもあります。 OpsIQの主な機能…
2,655
各リモートサイトは異なるブランディングを持つことができますか?
はい、OpsIQは、サイトを1つのワークスペースの下に保持しながら、サイトごとのブランディングと構成をサポートしています。この機能は、複数のブランド、地域のサイト、または代理店を持つグループにとって有益です。完全なホワイトラベル権は、サブスクリプションまたはパートナーの権利に依存することに注意してください。 関連する記事 OpsIQにおけるリモートサイトとは何ですか? 別のウェブサイトをOpsIQに追加するにはどうすればよいですか?…
2,650
API トークンを削除せずに一時的に無効にすることはできますか?
はい、API トークンはトークンを無効にし、後で再度有効にすることをサポートしています。統合が一時的にそれを使用しなくなるべきときにトークンを無効にできます。トークンが無効になっている間、接続された統合は認証に失敗することを忘れないでください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,560
OpsIQの独自の統合を構築できますか?
はい、Connector Builderを使用してOpsIQの独自の統合を構築できます。このツールを使用すると、アイデンティティ、認証、テスト、アクション、トリガーを定義し、メタデータをレビューできます。OpenAPI、Postman、またはcURLから統合を開始できます。…
2,550
OpsIQにおけるAPIレート制限はどのように機能しますか?
OpsIQはキーごとにAPIレート制限を適用し、レスポンスヘッダーにレート制限情報を返します。制限を超えた場合、クライアントはHTTP 429ステータスコードと、Retry-Afterヘッダーを通じて再試行のタイミングに関するガイダンスを受け取ります。 統合は、すぐに再試行するのではなく、バックオフ戦略を実装するべきです。プランの制限はキー、アクション、ウェブフック、統合、およびトリガーに対して別々に適用されることを覚えておくことが重要…
2,543
OpsIQを別のウェブサイトやアプリケーションに接続するためにwebhooksを使用できますか?
OpsIQに接続するためのWebhooksの使用 はい、webhooksを使用してOpsIQを別のウェブサイトやアプリケーションに接続できます。署名付きwebhooksは主要なイベント駆動型統合方法として機能し、一般APIとAIアクションは明示的な読み取りとコマンドを管理します。 信頼できる受信者は次のことを行うべきです: 署名とタイムスタンプを検証する イベントを検証する 冪等に処理する 失敗した配信を監視する
2,520
OpsIQはRESTおよびGraphQL統合をサポートしていますか?
はい、OpsIQは標準のRESTまたはGraphQLスタイルのAPIを通じて統合をサポートしています。コネクタモデルは、外部システムが公開する機能に焦点を当てています。 認証方法には次のものが含まれます: ベアラー APIキー ベーシック OAuth 2.0 HMAC カスタムスキーム コネクタは、サポートするコンテキスト、アイデンティティ、アクション、トリガー、および同期も宣言します。 関連する記事…
2,497
Self-Hosted ダウンロードに何が表示される可能性がありますか?
アカウントはメインの Self-Hosted パッケージを公開でき、あなたの権利と現在のリリースに応じて、追加の統合または開発者パッケージを公開できます。正確なパッケージ、バージョン、および利用可能性は現在のリリースとプランによって制御されます。したがって、古いパッケージリストに依存するのではなく、ライブダウンロードページに表示されているファイルを使用することをお勧めします。 関連する記事…
2,493
API トークンについてどのような情報を見ることができますか?
API トークン ページは、各トークンに関するさまざまな詳細を提供します。包括的に: トークン名 公開識別子 付与された権限 現在のステータス 使用情報(例:最後に使用された時期) 作成後、秘密自体は再表示されないことに注意してください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか? OpsIQ一般APIを通じて利用可能な操作はどれくらいですか?…
2,483
なぜ再度私のAPIトークンの秘密を見ることができないのですか?
トークンの秘密は、作成時にのみ意図的に表示されます。アカウントは、後で表示するための再利用可能な平文コピーではなく、将来のトークン使用を確認するために必要なものを保存します。秘密を失った場合は、交換用のトークンを作成し、失われたトークンを無効にするか削除する必要があります。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,461
自己ホストのダウンロード履歴を見ることはできますか?
はい、ダウンロード履歴機能が利用可能な場所でダウンロード履歴を表示できます。ダウンロード履歴機能は、パッケージがダウンロードされた日時、パッケージおよびバージョン情報、ファイルの詳細、サイズ、アカウントのセキュリティと監査に使用されるネットワーク情報を表示します。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ OpsIQドキュメントと開発者ドキュメント — OpsIQ…
2,456
クラウド顧客はライセンスキーが必要ですか?
通常、OpsIQ Cloud アクセスは、自己ホスト型ライセンスキーのインストールではなく、顧客所有のワークスペースとその権利に基づいています。顧客アカウント内のライセンスキーは、主に対象となる自己ホスト型製品に関連しています。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ OpsIQドキュメントと開発者ドキュメント — OpsIQ ポータルスタジオ管理者および開発者ガイド — OpsIQ…
2,431
署名されたWebhooksとAPIアクションによる自動化 — OpsIQ
OpsIQは、署名されたwebhooksとAPIアクションを通じてワークフローを自動化するための堅牢なソリューションを提供します。HMAC署名されたwebhooks、検証された受信イベント、管理されたバックエンドアクションなどの機能により、OpsIQは安全で信頼性の高いイベント処理を保証します。 主な機能: 双方向自動化: イベントとアクションを両方向でシームレスにトリガーします。HTTPS…
2,423
OpsIQにおけるリモートサイトとは何ですか?
リモートサイトは、1つのワークスペースが複数のウェブサイトで動作することを可能にします。各サイトにはユニークなsite_keyとドロップインスクリプトが割り当てられます。これらのサイトはハートビートを報告し、共有ワークスペースの一部でありながら独自のブランディングやチャット設定を持つことができます。データはサイトごとに行スコープされ、認可されたロールアップがクライアントやドメインの境界を消去しないことを保証します。 関連する記事…
2,414
OpsIQ一般APIにどのように認証しますか?
OpsIQ一般APIへの認証 OpsIQの一般APIはスコープ付きBearer APIキーを利用します。これらのキーは、その機能に必要な最小限の権限スコープのみが割り当てられることが重要です。さらに、これらは秘密として安全に保存され、公開ブラウザコードやリポジトリに含めるべきではありません。 開発者サイトは以下の詳細情報を提供します: 62の利用可能なスコープ 一般的なAPIエントリポイント レート制限ヘッダー 安定した運用契約…
2,406
セルフホステッドエディションをどのようにインストールしますか?
セルフホステッドエディションのインストール方法 セルフホステッドエディションをインストールするには、アクティブなセルフホステッド権利に対して利用可能な現在のパッケージをダウンロードします。そのリリースに付属するインストールまたはクイックスタートガイダンスに従ってください。サポートされているセットアッププロセス中に有効なセルフホステッドライセンスを使用することを確認してください。…
2,400
API トークンを削除するとどうなりますか?
トークンを削除すると、その顧客トークンがアクティブな使用から永久に削除されます。それにまだ設定されている統合は認証を停止し、アクセスが必要な場合は新しいトークンで更新する必要があります。永久的な削除の代わりに可逆的な一時停止を希望する場合は、まずトークンを無効にしてください。 関連する記事 OpsIQのアウトバウンドウェブフックはどのように署名されていますか? OpsIQ一般APIにどのように認証しますか?…
2,392
'未バインド'はセルフホステッドライセンスで何を意味しますか?
用語'未バインド'は、ライセンスが現在アカウント表示に記録されたドメインバインディングを持っていないことを示します。ドメインバインディングの動作は、製品やインストールフローによって異なる場合があります。 ライセンス情報を手動で編集するのではなく、現在のセルフホステッドパッケージに付属の指示に従ってください。 関連する記事 開発者API、Webhookおよびコネクタビルダー — OpsIQ OpsIQドキュメントと開発者ドキュメント —…
2,383
OpsIQ コネクタにとって、GA、プレビュー、または契約準備は何を意味しますか?
OpsIQ コネクタの GA、プレビュー、および契約準備の理解 GA は一般提供を意味し、これはバンドルパッケージがプラットフォームの一般提供リリースガバナンスを通過したことを示します。 プレビューは、バンドル統合が表示されているが、まだ GA としてラベル付けされていないことを示します。 マーケットプレイス契約準備は、統合がコネクタ契約に準拠していることを示します。ただし、所有権、サポート、および展開の点でバンドル GA…
2,379
なぜSelf-Hostedパッケージが利用できないと表示されるのですか?
パッケージは、主に2つの理由で利用できないと表示される場合があります:あなたの権利に対して公開されていないか、リリースの整合性要件が満たされていないためです。アカウントは、期待されるリリースチェックを通過しないパッケージを意図的に提供しません。そのような場合は、現在利用可能なパッケージを使用するか、必要なリリースが欠けている場合はサポートに連絡してください。 関連する記事 開発者API、Webhookおよびコネクタビルダー —…
2,378
OpsIQにおける顧客APIトークンとは何ですか?
顧客APIトークンは、アカウントのパスワードを共有することなく、サポートされている顧客スコープの統合を認証することを可能にします。これらのトークンは、トークンが作成される際に提供されるスコープに応じて、サポートされているアカウント、ライセンス、請求、またはサポート操作に対する制限された権限を持つことができます。統合には、実際に必要な権限のみを付与することが重要です。 関連する記事…
2,370
OpsIQはShopifyまたはWooCommerceと統合できますか?
はい、OpsIQはShopifyおよびWooCommerceと統合できます。OpsIQのコマースおよびSales Bridgeの資料は、ShopifyおよびWooCommerce、ならびに他のコマースプラットフォームの統合パターンを説明しています。 接続されたコマースは、次のような機能を提供できます: カート 注文 購入 返金 クーポン アイデンティティ コンバージョンイベント…
2,357
コネクタZIPをアップロードすると、すぐに公開されますか?
いいえ、コネクタZIPをアップロードしても、すぐには公開されません。著者がコネクタをアップロードすると、自動チェックとレビューを受ける提出物が作成されます。コネクタの公開は、提出物が現在のMarketplaceのセキュリティ、ポリシー、およびレビュー要件を満たすかどうかに依存します。Marketplaceが対応する承認済みまたは公開済みの状態を示すまで、提出されたバージョンは保留中と見なすべきです。 関連する記事 統合、API &…
2,344
OpsIQはどのようにして1つのリモートサイトが別のサイトのデータを見るのを防ぎますか?
OpsIQがリモートサイト間のデータ可視性を防ぐ方法 リモートサイトのレコードは特定のサイトスコープに割り当てられ、OpsIQは行レベルのスコーピングを実装して、データが承認されたサイトまたはワークスペースのコンテキスト内でのみアクセス可能であることを保証します。これにより、ユーザーは自分のサイトに関連するデータのみを表示できます。…
2,336
OpsIQ 顧客 API トークンを作成するにはどうすればよいですか?
OpsIQ 顧客 API トークンを作成するには、次の手順に従ってください: API トークンセクションを開きます。 説明的な名前でトークンを作成します。 適切な利用可能な権限を選択します。 トークンが作成されたら、秘密をすぐにコピーして安全に保管してください。完全な秘密は一度だけ表示されます。OpsIQ は検証目的のために保護された表現を保持し、元の秘密を後で再表示することはありません。 関連する記事…
2,314
なぜDownloadsメニューが見えないのですか?
メニューは権限に基づいており、アカウントに適格なSelf-Hosted製品がない場合やSelf-Hostedダウンロードが無効になっている場合は非表示になることがあります。アクティブなSelf-Hosted権限があると考えているが、Downloadsメニューにアクセスできない場合は、サポートに連絡し、My Productsに表示されている製品情報を提供してください。 関連する記事 開発者API、Webhookおよびコネクタビルダー —…
2,308
認証されたユーザーは、OpsIQ ポータルとリモート ドメインの間を移動できますか?
OpsIQ は、サイトキー、シークレット、役割/コンテキスト情報、および限られた有効期限に基づいた署名されたクロスオリジンアイデンティティトークンを説明しています。このメカニズムにより、リモートサイトは任意のブラウザ提供フィールドに依存することなく、信頼できるアイデンティティを確立できます。署名されたシークレットはサーバー側に留まる必要があり、侵害された場合はローテーションする必要があることに注意することが重要です。 関連する記事…
2,243
統合のために、アカウントパスワードの代わりにOpsIQ APIトークンを使用できますか?
はい、サポートされている顧客API操作のために、アカウントパスワードの代わりにOpsIQ APIトークンを使用できます。この方法は、インタラクティブアカウントパスワードとの統合を提供するよりも好ましいです。なぜなら、トークンは名前を付けたり、スコープを設定したり、監視したり、無効にしたり、独立して置き換えたりできるからです。トークンを秘密に保ち、ブラウザのURL、チケット、ログに含めないようにすることが重要です。 関連する記事…
1,951
まだヘルプが必要ですか?

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

サポートに連絡