API

REST-API Documentation

Quibblr can also be used via REST-API.

To use the API you need to create a API-Token. This can be done here.

Projects

Get all Projects

curl -v http://www.quibblr.it/api/projects?apiToken=API_TOKEN -H "Content-Type: appli/json" -H "Accept: application/json"

Get one Project

curl -v http://www.quibblr.it/api/projects/PROJECT_ID?apiToken=API_TOKEN -H "Content-Type: appli/json" -H "Accept: application/json"

Create a project

With Crawler

curl -v http://www.quibblr.it/api/projects?apiToken=API_TOKEN -d '{ "name": "PROJECT_NAME", "base_url":"PROJECT_BASE_URL", "crawl_url": "PROJECT_CRAWL_URL", "capture_presets" : "CAPTURE_PRESET" }' -H "Content-Type: application/json" -H "Accept: application/json"

PROJECT_BASE_URL: e.g. http://www.example.com

PROJECT_CRAWL_URL: e.g. http://www.example.com

CAPTURE_PRESET: "desktop" or "mobile"

With sitemap by xml

curl -v http://www.quibblr.it/api/projects?apiToken=API_TOKEN -d '{"name": "PROJECT_NAME", "base_url":"PROJECT_BASE_URL","capture_presets": "PROJECT_CRAWL_URL", "sitemap_by_xml": "XML_SITEMAP", "capture_preset" : "CAPTURE_PRESET" }' -H "Content-Type: appli/json" -H "Accept: application/json"

PROJECT_BASE_URL: e.g. http://www.example.com

CAPTURE_PRESET: "desktop" or "mobile"

XML_SITEMAP:

e.g. <?xml version=\"1.0\" encoding=\"utf-8\"?> http://www.example.com daily 1.00 http://www.example.com/leistungen.php daily 0.50 http://www.example.com/referenz.php daily 0.50 http://www.example.com/impressum.php daily 0.50 http://www.example.com/kontakt.php daily 0.50

With sitemap by url

curl -v http://www.quibblr.it/api/projects?apiToken=API_TOKEN -d '{"name": "PROJECT_NAME", "base_url":"PROJECT_BASE_URL","sitemap_by_url": "SITEMAP_URL", "capture_presets" : "CAPTURE_PRESET" }' -H "Content-Type: appli/json" -H "Accept: application/json"

PROJECT_BASE_URL: e.g. http://www.example.com

SITEMAP_URL: e.g. http://www.example.com/sitemap.xml

CAPTURE_PRESET: "desktop" or "mobile"

Versions

Get all versions of one project

curl -v http:///www.quibblr.it/api/projects/PROJECT_ID/versions?apiToken=API_TOKEN -H "Content-Type: application/json" -H "Accept: application/json"

Get one version

curl -v http://www.quibblr.it/api/projects/PROJECT_ID/versions/VERSION_ID?apiToken=API_TOKEN -H "Content-Type: application/json" -H "Accept: application/json

Create a version

curl -v http:///www.quibblr.it/api/projects/PROJECT_ID/versions?apiToken=API_TOKEN -d '{"name": "VERSION_NAME","project_id": "PROJECT_ID"}' -H "Content-Type: application/json" -H "Accept: application/json"

Compares

Get all compares of one project

curl -v http:///www.quibblr.it/api/projects/PROJECT_ID/compares?apiToken=API_TOKEN -H "Content-Type: application/json" -H "Accept: application/json"

Get one compare

curl -v http:///www.quibblr.it/api/projects/PROJECT_ID/compares/COMPARE_ID?apiToken=API_TOKEN -H "Content-Type: application/json" -H "Accept: application/json"

Create a compare

curl -v http:///www.quibblr.it/api/projects/PROJECT_ID/compares?apiToken=API_TOKEN -d '{"old_version_id": "OLD_VERSION_ID","new_version_id": "NEW_VERSION_ID"}' -H "Content-Type: application/json" -H "Accept: application/json"