イントロダクション

API キーを取得

Sofia API とは

Sofia API を使うと、コードから Sofia アカウントにアクセスできます。対象は、Workspace に属する店舗、連携済みのネットワーク、メディアライブラリ、投稿、統計です。HTTPS 上の REST API で、リクエストとレスポンスは JSON、すべてのエンドポイントは 1 つのベース URL の下にあります。

text
https://api.sofia-post.com/api/v1

API でできること

  • 投稿の公開：今すぐ、日時を指定して、または下書きとして、1 つまたは複数のネットワークへ同時に投稿できます。
  • 公開前のチェック：ドライランで、各ネットワークが投稿を受け付けるかどうかを確認できます。何も書き込まれません。
  • メディアの管理：ファイルをアップロードするか URL からインポートして、店舗のメディアライブラリに追加できます。
  • 投稿の追跡：ネットワークごとの状態、パーマリンク、失敗の理由を取得できます。署名付き webhook で知ることもできます。
  • 統計の取得：連携済みアカウントごとに Sofia が収集した最新の数値を取得できます。
  • ネットワークの連携：未連携のネットワークをオーナーが連携するための、ホスト型リンクを作成できます。

対象となる方

自分の Workspace を自動化する開発者は、個人キーで十分です。設定 › API で作成し、Bearer トークンとして送信します。ユーザーの Workspace を代理で操作する SaaS 製品の場合は、OAuth クライアントを登録します。各ユーザーが、自分で選んだ Workspace でアプリケーションを認可します。

次のステップ