Get Tools Lab
/
英語スペイン語フランセドイツ語イタリアーノポルトガル語オランダポルスキテュルクチェインドネシア語ティエン・ヴィエト日本語한국어中文العربيةहिन्दीবাংলাاردوไทยРусский
開発アクセス

Get Tools Lab 開発 API

認証された開発者エンドポイントを使用して、公開されたツール、ガイド、プラットフォーム ワークフローを統合します。利用可能な機能は、有効な API モジュールとアクセス レベルによって異なります。

API オプション

このプラットフォームには、REST エンドポイントと軽量の GraphQL 互換レイヤーが含まれており、API キー、OAuth クライアント資格情報、使用状況分析、レート制限、署名付き Webhook 配信がサポートされています。すべての公開 Web サイト機能が API を通じて自動的に利用できるわけではありません。

認証

REST v1 エンドポイントは API キーを使用できます X-API-Key ヘッダー。新しいエンドポイントでも、サポートされているベアラー トークンを受け入れることができます。すべての認証情報を秘密にし、公開された場合は直ちにキーをローテーションします。

curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"

共通の REST エンドポイント

ツールs

GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json

ガイドs

GET /api/v1/guides.php
GET /api/v1/guides.php?q=image

REST v2 と GraphQL

統合された開発者プラットフォームは、サポートされているリソースの新しい REST ルートと GraphQL 操作を公開できます。開発エリアと API プレイグラウンドを使用して、現在の展開で実際に有効になっているエンドポイントを確認します。

レート制限

API リクエストは、1 分ごとまたは 1 日ごとに制限される場合があります。制限を超えるリクエストは HTTP を返す可能性があります 429 Too Many Requests と再試行またはリセットの情報。アプリケーションは、失敗したリクエストをすぐに繰り返すのではなく、バックオフを使用する必要があります。

Webhook

サポートされているイベントは、HTTPS Webhook 宛先に配信できます。署名が有効になっている場合は、ペイロードを信頼する前に HMAC 署名を検証してください。 Webhook コンシューマは再試行を許容し、同じ配信によって重複したアクションが作成されないようにイベント処理を冪等にする必要があります。

エラーs

無効な認証情報、無効なクライアント、割り当て量の使い果たし、または不正なリクエストにより、HTTP 4xx ステータス コードを含む構造化 JSON エラーが返されることがあります。サーバー側の障害では 5xx 応答が使用されます。アプリケーションは、エラー レポートで秘密の資格情報を公開するのではなく、応答ステータスと要求識別子を利用可能な場合はログに記録する必要があります。

セキュリティ guidance

  • パブリック ブラウザーの JavaScript には秘密の API キーを決して埋め込まないでください。
  • API および Webhook トラフィックには HTTPS を使用します。
  • クライアントには必要な権限のみを与えます。
  • Webhook 署名を検証します。
  • 侵害された認証情報をローテーションします。
  • 文書化されたレート制限とファイルサイズ制限を尊重してください。

SDK とプレイグラウンド

SDK のサンプルとインタラクティブなプレイグラウンドについては、開発セクションを参照してください。運用ファイルや顧客情報を使用する前に、機密データ以外のデータとの統合をテストします。