KinstaのREST API(Application Programming Interface)は、開発者によるKinstaのアカウントやプロジェクトに関連した簡単なアクセス、やり取りを支援する機能です。APIを使うことで、Kinstaのプラットフォームでの作業が楽になり、効率的にデータを取得したりアクションを実行したりタスクを自動化したりできます。

前提条件

KinstaのAPIを使用するには、アカウントとMyKinstaに少なくとも1つのWordPressサイトアプリケーション、またはデータベースがある必要があります。また、APIを通じてアカウントを認証し、アクセスするためにAPIキーを生成する必要があります。

一般的な使用例

レポートの作成

APIを使用してデータを読み込むことができるので、独自のレポートを作成したり、内部の追跡システムにKinstaサービスを統合したりすることができます。サイト管理に関連する代行業を営んでおり、すべてのクライアントをリストアップするアプリケーションを使用するには、APIを使用して、各クライアントに属するすべてのKinstaサイトアプリケーション、およびデータベースを取得することができます。

定期的なタスクの実行

アプリケーションを作成し、サイトのパフォーマンスに影響を与えたり、ダウンタイムを引き起こす可能性のあるタスクを夜間に設定することができます。例えば、夜間にサイトのキャッシュをクリアすることで、サイト訪問者の混乱を最小限に抑えることも可能です。

WordPressサイトの作成

APIを使用して、WordPressサイトを作成可能です。例えば、代行業を運営する中で、毎回MyKinstaにログインすることなくサイト作成作業を自動化できるようにしたい場合には、APIを使用してサイトを作成し、WooCommerce、Yoast SEO、Easy Digital Downloadsをインストールすることができます。

また、WordPressマルチサイトを作成し、サブドメイン(is_multisite TRUE)またはサブディレクトリ(is_subdomain_multisite FALSE)の構成を指定可能です。

サイトの作成状況を確認するには、Operationsのエンドポイントを使用します。

認証とユーザーアクセス

アカウントでAPIにアクセスし使用するには、MyKinstaでAPIキーを生成する必要があります。始めるには、APIキーページ((ユーザー名)>「企業の設定」>「APIキー」)に移動し、「APIキーの作成」をクリックします。

  1. 有効期限を選択するか、有効期限の開始日と時間を指定
  2. キーに名前を付ける
  3. 生成」をクリック

APIキーは、この時だけ表示されます。必ずコピーして、安全な場所に保管してください。

企業の所有者企業の管理者企業の開発者が、APIキーを作成できます。APIのアクセスレベルは、ユーザーの役割に依存します。例えば、企業の開発者が生成したAPIキーは、企業の所有者や管理者が生成したキーと同じアクセス権を持ちません。

複数のAPIキーを生成することができ、「APIキー」ページに表示されます。APIキーのアクセスを取り消すには、対象のAPIキーの横にある「取り消す」をクリックします。

操作状況の確認

時間のかかる可能性のある操作(サイトの作成、キャッシュのクリア、PHPの再起動など)に対して、APIは結果を即座に応答することはありません。これは、操作に時間がかかったために、サーバーのスレッドがブロックされたり、ゲートウェイがタイムアウトしたりする可能性を防ぐための仕様です。

操作の状態を確認するには、/operationsエンドポイントを使用します。オペレーションを開始すると、APIからの即時応答には、/operationsエンドポイントで使用するためのoperation_idが含まれます。詳細と例は、こちらのリファレンスをご参照ください。

レート上限

APIが多くのリクエストで溢れるのを防ぐため、1分あたりのリクエスト数は60件に制限されています。ただし、サイト作成は例外で、1分あたり5件のリクエストに制限されています。

レート上限に関連する情報を把握するには、直近のAPIレスポンスに含まれるRateLimitヘッダを確認してください。

RateLimit-Limit: 60

RateLimit-Remaining: 50

RateLimit-Reset: 60

現在、レート上限を引き上げることはできません。

トラブルシューティング

APIキーがアクセスできないエンドポイントにリクエストした場合、アクセスできないことを知らせるエラーメッセージが表示されます。そのエンドポイントへのアクセスが必要な場合は、企業の所有者または管理者がAPIキーを生成する必要があります。

APIリファレンス

利用可能なAPIエンドポイントの詳細、OpenAPI関連資料のダウンロード、およびエンドポイントの試用については、APIリファレンスをご覧ください。

関連ドキュメント

参照コンテンツ