Return to API Main

oEmbedcacoo.comSDK

Endpoint URL for oEmbed embedding. You can fetch the information, such as the URL of diagram viewers that uses iframe.

URL

http://cacoo.com/oembed.format?url=diagramURL
Example : http://cacoo.com/oembed.json?url=https%3A%2F%2Fcacoo.com%2Fdiagrams%2F00e77f4dc9973517

Request Method

GET

Format

json, xml

Authentication

Not necessary (The specified diagram needs to a public resource.)

Parameters

Parameter Name Type Content Default Example
url(Required) String URL of the diagram detail page http://cacoo.com/diagrams/00e77f4dc9973517
maxwidth Integer Maximum width of embedding viewer 450 600
maxheight Integer Maximum height of embedding viewer 350 400

Response

Field Type Description Example
type String Media type.
  • rich - Only
rich
version String Version of oEmbed 1.0
title String Title of Diagram Wireframe
description String Title of Description Current project wireframe
author_name String Owner's user name 1MUJPfNEEeVUox35
provider_name String Provider name Cacoo
provider_url String Provider URL http://cacoo.com/
thumbnail_url String URL of thumbnail image https://cacoo.com/diagrams/00e77f4dc9973517-w450-h350.png
thumbnail_width Integer Width of thumbnail image 450
thumbnail_height String Height of thumbnail image 350
html String HTML for embedding <iframe src="http://cacoo.com/diagrams/00e77f4dc9973517/view?w=448&h=320" width="450" height="350" frameborder="0" ></iframe>
width Integer Width of embedding viewer 450
height Integer Height of embedding viewer 350

JSON Response Example

{
    "type": "rich",
    "version": "1.0",
    "title": "Wireframe",
    "description": "Current project wireframe",
    "author_name": "1MUJPfNEEeVUox35",
    "provider_name": "Cacoo",
    "provider_url": "http://cacoo.com/",
    "thumbnail_url": "https://cacoo.com/diagrams/00e77f4dc9973517-w450-h350.png",
    "thumbnail_width": 450,
    "thumbnail_height": 350,
    "html": "<iframe src="http://cacoo.com/diagrams/00e77f4dc9973517/view?w=448&h=320" width="450" height="350" frameborder="0" ></iframe>",
    "width": 450,
    "height": 350
}
									

XML Response Example

<?xml version="1.0" encoding="utf-8"?>
<oembed>
  <type>rich</type>
  <version>1.0</version>
  <title>Wireframe</title>
  <description>Current project wireframe</description>
  <author_name>1MUJPfNEEeVUox35</author_name>
  <provider_name>Cacoo</provider_name>
  <provider_url>http://cacoo.com/</provider_url>
  <thumbnail_url>https://cacoo.com/diagrams/00e77f4dc9973517-w450-h350.png</thumbnail_url>
  <thumbnail_width>450</thumbnail_width>
  <thumbnail_height>350</thumbnail_height>
  <html>&lt;iframe src="http://cacoo.com/diagrams/00e77f4dc9973517/view?w=448&amp;h=320" width="450" height="350" frameborder="0" &gt;&lt;/iframe&gt;</html>
  <width>450</width>
  <height>350</height>
</oembed>
									
Return to API Main