シンアカウントAPI
シンアカウントAPIとは
ドメイン、メールアカウント、WordPress、データベースなどの各設定を、外部プログラムやAIエージェントから操作できるAPIです。
| 対象プラン | ベーシック、スタンダード、プレミアム、ビジネス・ベーシック、ビジネス・スタンダード、ビジネス・プレミアム |
|---|
APIのご利用方法
シンアカウントAPIを利用するには、まずAPIキーを発行する必要があります。
APIキーはシンアカウントから発行・管理が行えます。
APIキーの発行手順
1.「APIキー管理」をクリック
シンアカウントへログインし、サービスメニューの「APIキー管理」をクリックします。
2.「APIキー追加」をクリック
「APIキー追加」ボタンをクリックし、必要事項を入力します。
3. APIキーの確認
発行が完了すると、APIキーが表示されます。APIキーは xs_ で始まる文字列です。
APIキーの削除手順
発行したAPIキーが不要になった場合や、外部への漏洩が疑われる場合は、以下の手順で速やかに削除を行ってください。
- 削除が必要なケース
-
- APIを利用したプログラムの開発や運用が終了したとき
- 連携していた外部サービスやAIエージェントの利用を止めるとき
- APIキーを誤って公開設定の場所に保存してしまったとき（漏洩の疑い）
1.「APIキー管理」をクリック
シンアカウントへログインし、サービスメニューの「APIキー管理」をクリックします。
2.「削除」をクリック
「APIキー一覧」にて、対象キーの右側にあるメニューボタン（3点リーダー）をクリックし、「削除」を選択します。
3.「削除する」をクリック
確認画面で「削除する」をクリックすると、即座にそのキーは無効化されます。
APIキー作成上限
1サーバーアカウントあたりのAPIキー作成上限は以下の通りです。
| プラン | APIキー上限 |
|---|---|
| ベーシック | 5 |
| スタンダード | 10 |
| プレミアム | 無制限 |
| ビジネス・ベーシック | 10 |
| ビジネス・スタンダード | 無制限 |
| ビジネス・プレミアム | 無制限 |
レート制限
シンアカウントAPIでは、APIリクエスト数にレート制限を設けています。
レート制限は、サーバーアカウント単位で適用されます。
| プラン | リクエスト/分 | リクエスト/日 | 同時接続数 |
|---|---|---|---|
| ベーシック | 60 | 10,000 | 5 |
| スタンダード | 120 | 30,000 | 10 |
| プレミアム | 300 | 100,000 | 20 |
| ビジネス・ベーシック | 120 | 30,000 | 10 |
| ビジネス・スタンダード | 300 | 100,000 | 20 |
| ビジネス・プレミアム | 300 | 100,000 | 20 |
APIの仕様
各APIの詳細な仕様については、APIリファレンスをご参照ください。
