エディタ
エディタのURL。図を編集状態で開きます。このURLはブラウザで開く必要があります。
メソッド
GET, POST
URL
https://cacoo.com/diagrams/diagramId/edit
例1：https://cacoo.com/diagrams/00e77f4dc9973517/edit?editorToken=nITfHr0rxfeAxdCn
例2 : https://cacoo.com/diagrams/00e77f4dc9973517/edit?automationToken=wAHbE0gJ8DgRIUhy
例3(parameterはUTF-8でURLエンコードする必要があります)：
https://cacoo.com/diagrams/00e77f4dc9973517/edit?parameter=%7B%22mode%22%3A%22normal%22%2C%22callbackUrl%22%3A%22http%3A%2F%2Fexample.com%2Fcallback%22%2C%22visibleStencils%22%3A%5B%22basic.balloon%22%5D%2C%22buttons%22%3A%5B%7B%22label%22%3A%22Prev%22%2C%22action%22%3A%22saveAndExit%22%2C%22callbackParam%22%3A%22PREV%22%7D%2C%7B%22imageUrl%22%3A%22http%3A%2F%2Fexample%2Fnext.png%22%2C%22action%22%3A%22exit%22%2C%22callbackParam%22%3A%22NEXT%22%7D%5D%7D
フォーマット
HTML
認証
Cacooのアプリケーションによる認証
パラメーター
| パラメータ名 |
型 |
内容 |
例 |
| diagramId(必須) |
文字列 |
図のID |
00e77f4dc9973517 |
| parameter |
JSON文字列 |
起動パラメータ。JSON形式の文字列をUTF-8でURLエンコードして渡す必要があります。 |
{“mode”: “normal”,“callbackUrl”: “http://example.com/callback","visibleStencils": [ “basic.balloon” ],“buttons”: [{“label”: “Prev”, “action”: “saveAndExit”, “callbackParam”: “PREV”},{“imageUrl”: “http://example/next.png”, “action”: “exit”, “callbackParam”: “NEXT”}]} |
| editorToken |
文字列 |
Cacooへサインインせずにエディタを開くためのトークン文字列。エディタのトークン取得APIを参照してください。 |
nITfHr0rxfeAxdCn |
| automationToken |
文字列 |
エディタを開いたときに自動実行する処理を呼び出すためのトークン文字列。エディタの自動処理登録APIを参照してください。 |
wAHbE0gJ8DgRIUhy |
起動パラメーター
| パラメータ名 |
型 |
内容 |
デフォルト |
例 |
| mode |
文字列 |
起動モード。値はnormal,simpleのいずれか。simpleだと保存パネル、招待パネル、エクスポートパネルが非表示になります。 |
“normal” |
“simple” |
| callbackUrl |
文字列 |
エディタ終了後に遷移するURLです。未指定だと通常終了します。 |
|
“http://example.com/callback" |
| visibleStencils |
配列(文字列) |
エディタ起動時に表示状態になっているステンシル名です。これ以外のステンシルは非表示になります。未指定だと通常表示します。 |
|
[“basic.balloon”] |
| buttons(必須) |
配列 |
終了ボタンの定義。この配列の個数だけボタンが表示されます。 |
|
- |
| + label |
文字列 |
ボタンに表示するラベル文字列。imageUrlより優先して適用されます。 |
|
“Next” |
| + imageUrl |
文字列 |
ボタンの画像URL。labelもimageUrlも未指定だと通常のボタンの画像になる |
|
“http://example/next.png” |
| + action |
文字列 |
ボタンクリック時の動作。normal,saveAndExit,exitのいずれか。saveAndExitだと、強制保存後終了。exitだと保存せずに終了。 |
“normal” |
“saveAndExit” |
| + callbackParam |
文字列 |
どのボタンをクリックしたかを呼び出し元のアプリケーションで判別するための文字列。callbackUrlが指定されている場合に、この値が_cacooStatus=の型式でクエリパラメータとしてURLに付加されます。 |
|
“NEXT” |
ステンシル一覧
| ステンシルキー |
ステンシル名 |
| basic.basic |
基本 |
| basic.balloon |
吹き出し |
| basic.people |
人 |
| basic.smiley |
スマイリー |
| basic.greetingcard |
グリーティングカード |
| basic.dimensionline |
寸法線 |
| office.office |
オフィス機器 |
| office.network |
ネットワーク |
| office.officelayout |
オフィスレイアウト |
| office.slim_down |
シンプルアイコン |
| web.sitemap |
サイトマップ |
| web.wireframe |
ワイヤーフレーム |
| web.freehand |
手書きワイヤーフレーム |
| web.webservice |
Webサービス |
| software.flowchart |
フローチャート |
| software.uml |
URL |
| software.er |
ER図 |
| software.file |
ファイル |
| software.iphone |
iPhone |
| software.ipad |
iPad |
| software.android |
Android |
起動パラメータの例
{
"mode": "normal",
"callbackUrl": "http://example.com/callback",
"visibleStencils": [ "basic.balloon" ],
"buttons": [
{"label": "Prev", "action": "saveAndExit", "callbackParam": "PREV"},
{"imageUrl": "http://example/next.png", "action": "exit", "callbackParam": "NEXT"},
]
}
レスポンス
エディタのHTMLがレスポンスとして返ります。