Embed api

The "Embed API" let's you generated live and responsive embeds for any content online from any webpage online through an api call request.

How to use the Embed api

To use the Embed API, make a HTTP GET request to the following endpoint

https://parsebot.com/api/v1/embed

Required parameters

These parameters must be sent along with the request.

Parameters

Description

key

The api key provided to you after registeration.

type

The type of content you want to embed. (article, images, videos, product, discussion)

url

Url to the page of the content you want to embed... (url should be encoded) or short url to the page if available.

Optional parameters

These parameters can also be sent along with the request.

Parameters

Description

callback

Callback function: used for cross domain AJAX referencing.

view

Embed view (Cards or full).

skin

Skin color for the embed.

property

Contents you want don't to show on the embed.

title

New title to the embed.

source

New source name.

source-url

New source url.

author

New author name.

source-url

New author url.

share-buttons

Share buttons to show on the embeds (facebook, twitter )

share-url

New url to the content shared. (should be url encoded.)

Example request

Let's make an example request using the following parameters

https://parsebot.com/api/v1/embed?key=Ajdj02399iunjd2342jn34342nn&type=article&url=http%3A%2F%2Fexample.com

Response returned when using the embed api

Data is always returned in JSON format... Response returned includes requests(meta-data for the specific request) and objects(array of extracted contents from the page).

Some of the fields returned after every successful request...

code

Embed code for the request to use on your web page.