REST API
BulkPublish
REST APIでSNS投稿を予約・公開する
アプリが使っているのと同じAPIを、あなたにも。投稿の作成と予約、メディアのアップロード、チャンネルの管理、分析の取得を、どの言語からでもHTTPとJSONで行えます。
自社のプロダクト、社内ツール、データパイプラインに投稿機能を組み込みたいチームで、ライブラリを1つ増やすのも避けたい場合に向いています。
REST API の設定
APIキーを作ってBearerトークンとして送り、まずは対話型のリファレンスから始めましょう。コードを1行も書く前に、すべてのリクエストをブラウザで試せます。
- BulkPublishのアカウントを作り、投稿したいチャンネルをつなぎます。
- 設定を開き、次に開発者を開いて、APIキーを作ります。キーは1つの組織に属していて、ほかに影響を与えずに失効できます。
- リクエストごとにキーをbearerトークンとして送ります。リファレンスには操作ごとに動く例が載っています。
REST API の操作一覧
REST APIから使える操作は116個あり、下では19つの分野に分けています。REST APIがやり取りするコードから読み取った一覧なので、どれも今すぐ使えます。
| 分野 | 操作 |
|---|---|
| 分析 | Account-level analytics,Engagement metrics,Per-post metric history,Summary stats,Tracked-link performance,Trigger metrics sync |
| APIキー | API usage history,API usage stats,Create API key,Delete API key,List API keys |
| カレンダーメモ | Create calendar note,Delete calendar note,List calendar notes,Update calendar note |
| チャンネルセット | Create channel set,Delete channel set,List channel sets,Update channel set |
| チャンネル | Check channel health,Disconnect channel,Get channel,Get platform-specific options for a channel,List channels,List platforms and their availability,Search users for @mention,Update channel settings |
| クライアント接続リンク | Create a client connect link,List client connect links,Revoke a client connect link |
| ハッシュタググループ | Create hashtag group,Delete hashtag group,Get hashtag group,List hashtag groups,Update hashtag group |
| 受信箱 | Get a conversation's messages,Like, hide or delete a comment on a published post,List conversations,Reply in a conversation,Reply to a comment on a published post,Update a conversation (read, archive, snooze, assign) |
| ラベル | Create label,Delete label,List labels,Update label |
| メディア | Abort multipart upload,Complete multipart upload,Delete media file,Finalize a direct upload,Get a direct upload URL,Get media file,Get media labels,Get media thumbnail,List media files,Set alt text,Set media labels,Start multipart upload (large videos, up to 1GB),Upload media (single request) |
| 通知 | Delete notifications,Get notification preferences,List notifications,Mark as read,Register a mobile push token,Unregister a mobile push token,Update preferences |
| OAuth | Exchange an authorization code or refresh token,Revoke a token |
| 組織 | Create organization,Delete organization,Get organization details,Leave an organization,List organizations,Rename organization,Switch active organization |
| 投稿 | Approve a pending post,Attach or detach a post's recurring schedule,Bulk actions,Create or get the post's review link,Create post,Delete post,Get next available queue slot,Get post,Get post engagement (commenters + reactors),Get post metrics,List posts,Publish as Story,Publish immediately,Reject a pending post,Retry failed platforms,Revoke the post's review link,Update post |
| レビューリンク | Create a client review link for a batch of posts,List client review links,Revoke a client review link |
| RSS自動投稿 | Add RSS feed,Delete RSS feed,List RSS feeds,Update RSS feed |
| 繰り返し予約 | Create schedule,Delete schedule,Get schedule,List recurring schedules,Update schedule |
| テンプレート | Create post template,Delete post template,Get post template,List post templates,Update post template |
| ユーティリティ | Activity log,Add extra channel slots,Create AI credits checkout,Create X credits checkout,Generate an AI caption,Get quota usage,Preview link metadata,X (Twitter) API spend |
投稿の届き先
REST APIで予約した投稿は、ここにある15のネットワークのどれにでも届けられます。1アカウントだけでも、全アカウント同時でもかまいません。各ネットワークのページで上限や投稿形式を確認できます。
詳細
REST APIの実用的な情報をまとめました。設定するときにも、あとで確認するときにも使えます。
| 項目 | 内容 |
|---|---|
| 認証 | APIキー。設定、次に開発者から作成します |
| 操作数 | 116個の操作 |
| 対応SNS | 15のSNS |
よくある質問
REST APIを接続する前によく寄せられる質問です。
コードを書く前にリクエストを試せますか?
はい。インタラクティブなリファレンスから、すべてのリクエストをブラウザで送れるので、コードを1行も書く前に実際のレスポンスを確認できます。
どの言語からAPIを呼び出せますか?
JSONでHTTPを送れる言語ならどれでも使えます。NodeやPythonを使うなら、同じAPIをラップしたSDKがあります。
BulkPublishのどこまで届きますか。
上の表にある116個の操作です。投稿、メディア、ラベル、チャンネルセット、繰り返し予約、RSS自動投稿、分析まで、アプリ自身が呼んでいるものはすべて含まれます。
認証はどうなっていますか。
APIキーをbearerトークンとして送ります。設定、次に開発者から作成してください。キーは1つの組織に属していて、ほかのキーに触れずに単独で失効できます。
画像や動画はアップロードできますか。
できます。小さいファイルは1リクエストで、大きい動画は直接アップロード用のURLを受け取ってストレージへ分割送信します。どちらの方法でもメディアIDが返り、それを投稿に添えます。
まだ解決しませんか?ヘルプセンターで手順を詳しく説明しています。
ガイドとチュートリアル
REST APIを使ったブログのチュートリアル。
ほかの連携
BulkPublishはほかにも5のツールと連携できます。気になるものを選んで、接続方法を見てみてください。