ShodoのAPIが公開されました!
たとえば記事をバックアップしたり、ドキュメントのビルド用に一括でダウンロードしたり、ヘッドレスCMSとしてご活用ください。
APIドキュメントはこちらです。
APIを利用する準備 ⛅
APIを利用するには、Shodoのプロジェクトごとにトークンを作成してください。
プロジェクトの画面から「設定」→「API連携」という画面を開いてください。
API・システム連携設定の画面でトークンを作成できます。このトークンを使ってプロジェクト内の記事や執筆タスクを取得できます。
たとえば以下のようにして執筆した記事を取得できます。
http -A bearer -a {取得したトークン} https://api.shodo.ink/@{組織名}/{プロジェクト名}/files/
Shodo CLI 💻
さらに、記事と画像を一括でダウンロードできるコマンドも作成しましたので、ぜひご利用ください。
コマンドを実行して、書いた記事のファイルと画像をローカルにダウンロードできます。
$ shodo download
助けてください!🙏
ShodoのAPIやコマンドはまだまだ始まったばかりです。
「こんなAPIもほしい!」、「こんな機能があれば、こう使えるのに!」という要望があればぜひ教えてください。
たとえばWebhookを用意すれば、執筆ステータスの変更にあわせてVercelでビルドできるかもしれません。他にも何か「ShodoでMarkdownを書いて、こうできれば嬉しいのに」ということがあればご連絡ください。
Shodoをご利用中であれば画面右下のチャット欄から、そうでないときはお問い合わせ画面からご連絡ください。どんな些細な感想でもいただければ嬉しいです。
ぜひ、ShodoでMarkdownを書いてレビューしてください!
執筆:Kiyohara Hiroki (@hirokiky)
(Shodoで執筆されました)