パブリックAPI

oviceのパブリックAPIを利用します。oviceの機能を外部サービスやシステムと連携、統合させることで、より効率的な組織管理や効果的なコラボレーションを実現します。

 

対象プラン

全てのプラン

※Freeプランでは、リクエスト数の制限等、事前の告知なく仕様が変更となる場合がありますのでご了承ください。

 

APIキーの生成に必要な権限

組織オーナー

 

APIキーの生成

1. スペースヘッダーの三本マークをクリックし「組織」タブを選択
組織タブは組織オーナーのみアクセス可能です。
組織オーナーの管理

Screenshot 2023-04-28 at 11.08.20 AM.png

2. 組織の設定→ API管理 →「コンソール」タブ →「APIキーを生成」をクリック

3. APIキーの名称を入力し「作成」をクリック

3. クライアントID、クライアントシークレットをそれぞれコピーし「確認して閉じる」をクリック

クライアントシークレットは生成時のみ表示されます。「確認して閉じる」をクリックすると再表示できないので、必ずコピーしてセキュアな場所に保管してください。
コピーせず画面を閉じてしまった場合は、一度APIキーを削除し再生成してください。
APIキーの削除

 

APIの利用

以下を参照してください 。
APIリファレンス

 

APIキーのアクティブ化/非アクティブ化

APIキーの構成を削除せずに、一時的にアクティブ、非アクティブを切り替えます。

1. APIキーの「アクション」→「更新」をクリック

スクリーンショット 2024-01-17 午前10.29.13.png

2. アクティブ、非アクティブを選択し「保存」をクリック

 

APIキーの削除

APIキーの構成を完全に削除します。

1. APIキーのステータスを非アクティブ化
APIキーのアクティブ化/非アクティブ化

2. APIキーの「アクション」→「削除」をクリック

スクリーンショット 2024-01-17 午前10.31.34.png

3. 「削除」をクリック

 

Tips

  • APIキーは、1つの組織に対し1つ発行されます。
  • APIを実行する際は、外部がクライアントIDとクライアントシークレットにアクセスできないよう、ブラウザなどのクライアント側ではなくサーバー側で実行してください。
  • 万が一クライアントIDとクライアントシークレットが漏洩してしまった場合は、直ちに削除して再発行してください。
    APIキーの削除

このセクションの記事