開発者 API

Joystick 開発者 API を使用すると、製品の構成リソースや設定にプログラムでアクセスして変更できます。これには、製品の一部である環境、ウェブフック、スキーマ、設定などが含まれます。これにより、強力な自動化、ワークフロー、連携が可能になります。

はじめに

通常は Joystick CMS を通じて実行する必要がある多くの機能に、API を通じてアクセスできるようになりました。

開発者 API を使用するにはプロダクト API キーが必要です。プロダクト API キーは、Joystick 内のそのプロダクトに属するすべてのエンティティにのみアクセスできます。プロダクト API キーを管理するには、組織の「編集者」または「所有者」権限が必要です。

プロダクトビューに移動します。右上の「プロダクト設定」をクリックします。

プロダクト API キーの管理をクリックします。

アクセスレベル	説明
読み取り専用	ほとんどの GET エンドポイントへのアクセス
基本アクセス	設定の作成、更新、アーカイブ、設定の同期、プッシュリクエストの作成が可能。他のエンティティの変更、削除、アーカイブはできない
フルアクセス	削除やアーカイブの能力を含め、すべてのエンティティに対する完全な制御権

ヘルプが必要ですか？

ヘルプや追加のアクセスが必要な場合は、弊社チームにお問い合わせください。

プロダクト API キーは多くの管理エンドポイントで使用できます。これを使用して、プロダクト、環境、設定コンテンツ、設定の同期などを管理できます。

リクエスト

METHOD https://capi.getjoystick.com/...

エンドポイントの完全なリストはこちらでご確認ください：https://capi.getjoystick.com/developer-api。

ヘッダー	値	必須	備考
`x-product-api-key`	あなたのプロダクト API キー	はい	対象とするプロダクト用に作成された API キー。これは設定取得に使用される API キーとは異なります。

問題がありますか？質問やリクエストがある場合は、Discord で弊社チームにお問い合わせください。

API の使用とセキュリティ