LayerBackのロゴLayerBack ドキュメント
LayerBackのロゴLayerBack ドキュメント
トップページ

はじめに

はじめに

API

変換API

変換API

LayerBack APIで図の画像を編集可能なVSDX・PPTX・draw.io・SVGへ変換するための認証、ジョブ作成、取得方法です。

認証

設定 → APIキーでキーを作成し、すべてのリクエストに付与します。

x-api-key: <your key>

変換にはAPIキー所有者の残高から10クレジットを使用します。4つの出力形式が含まれ、失敗した処理は自動で返金されます。

変換を開始する

PNG、JPEG、WebPの画像データをそのまま送信します。

curl -X POST https://layerback.com/api/v1/convert \
  -H "x-api-key: $LAYERBACK_KEY" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @diagram.png
{ "job_id": "5c048e6f-ec4d-43ad-9eee-0697414d5cef" }

残高不足は402、20MB超過は413、非対応データは415、時間あたりの上限超過は429を返します。

処理状況を確認する

curl https://layerback.com/api/v1/jobs/$JOB_ID \
  -H "x-api-key: $LAYERBACK_KEY"
{
  "job_id": "5c048e6f-…",
  "status": "succeeded",
  "total_seconds": 46.9,
  "formats": ["vsdx", "pptx", "drawio", "svg", "ir", "preview"]
}

statusはqueued → running → succeededまたはfailedの順で変わります。数秒おきに確認してください。通常は30〜60秒で完了します。

ファイルをダウンロードする

curl -L "https://layerback.com/api/v1/jobs/$JOB_ID/download?format=vsdx" \
  -H "x-api-key: $LAYERBACK_KEY" -o diagram.vsdx

formatにはvsdx、pptx、drawio、svg、構造化JSONのir、PNGプレビューのpreviewを指定できます。ダウンロードの繰り返しに追加クレジットはかかりません。

短時間だけ有効なダウンロードURLへ302で転送される場合があります。curlでは-Lを付け、HTTPクライアントではリダイレクトを許可してください。

完了Webhook

ポーリングを避けたい場合は、変換開始時にcallback_urlを指定します。成功・失敗にかかわらず、処理完了時に結果をPOSTします。

curl -X POST "https://layerback.com/api/v1/convert?callback_url=https://your.app/hooks/layerback" \
  -H "x-api-key: $LAYERBACK_KEY" \
  --data-binary @diagram.png

callback_urlには公開されたhttps URLが必要です。配信は2回まで試行します。重要な処理ではジョブAPIでも結果を確認してください。

OpenAPI

機械可読な仕様はlayerback.com/openapi.yamlにあります。Postmanへの読み込みや、型付きクライアントの生成に利用できます。

制限

  • PNG / JPEG / WebP、1画像20MBまで
  • 1アカウントあたり1時間20回。大量移行や自動化では davie@daviechen.com へご相談ください
  • 生成ファイルは少なくとも72時間保持されます。必要なファイルは早めに保存してください

はじめに

図の画像から、編集可能なVisio・PowerPoint・draw.ioを作成する

目次

認証
変換を開始する
処理状況を確認する
ファイルをダウンロードする
完了Webhook
OpenAPI
制限