この記事では、WorkivaのAPIドキュメントへのアクセス方法と、利用可能なAPIの概要について説明します。
Workiva開発者ハブを使用して、API機能を調査し、エンドポイントを確認し、Workivaとの統合を開始することができます。
Workiva Developer Hubにアクセスする
Workiva Developer Hub にあるすべての API ドキュメントと開発者向けリソースにアクセスできます。
- APIリファレンス・ドキュメント
- 認証ガイダンス
- リクエストとレスポンスの例
- インテグレーション構築のための開発者リソース
利用可能なAPI
WorkivaのAPIは、製品分野とユースケース別に構成されています。
プラットフォームAPI
Platform APIを使用して、以下のような Workiva のコア機能と対話します：
- ドキュメント
- スプレッドシート
- プレゼンテーション
- グラフ
- タスク
チェーンAPI
Chains API を使用する：
- チェーン・ランの管理
- ワークスペースのメタデータを取得する
- ワークフローの自動化
Wdata API
Wdata API を使用してください：
- データソースへの接続
- データのキュレーションと変換
- データセットを調べる
スプレッドシートAPI
Spreadsheets API を使用してください：
- データをスプレッドシートにインポートする
- 既存データの更新
- スプレッドシート・データの取得
管理者API
Admin API を使用してください：
- ユーザー管理
- 組織を構成する
- ワークスペースの管理
アイデンティティ・アクセス管理（IAM）API
IAM APIを使用する：
- APIリクエストの認証
- アクセスを安全に管理
知っておくべきこと
- 開発者ハブは、すべてのWorkiva APIドキュメントの真実の情報源です。
- APIアクセスには、ワークスペースの適切な権限または設定が必要な場合があります。
- APIリクエストの前に認証が必要