xBrowserSync API

Status:

Version:

This xBrowserSync service provides a REST API that the xBrowserSync client apps use to sync browser data with the service. The available API methods are listed below.

For more information visit the xBrowserSync website or check out the API Git Hub repo.

Bookmarks

Create Bookmarks

Post /bookmarks

Creates a new bookmark sync using the provided encrypted bookmarks.

Post body example:

{
  "bookmarks":"DWCx6wR9ggPqPRrhU4O4oLN5P09onApoAULX4Xt+ckxswtFNds..."
}
  • bookmarks: Encrypted bookmark data salted using secret value.

Response example:

{
  "id":"52758cb942814faa9ab255208025ae59",
  "lastUpdated":"2016-07-06T12:43:16.866Z"
}
  • id: 32 character alphanumeric ID created to identify synced bookmarks.
  • lastUpdated: Last updated timestamp for created bookmarks.

Get Bookmarks

Get /bookmarks/{id}

Retrieves an existing bookmark sync corresponding to the provided sync ID.

  • id: 32 character alphanumeric ID identifying synced bookmarks.

Response example:

{
  "bookmarks":"DWCx6wR9ggPqPRrhU4O4oLN5P09onApoAULX4Xt+ckxswtFNds...",
  "lastUpdated":"2016-07-06T12:43:16.866Z"
}
  • bookmarks: Encrypted bookmark data salted using secret value.
  • lastUpdated: Last updated timestamp for retrieved bookmarks.

Update Bookmarks

Put /bookmarks/{id}

Updates an existing bookmark sync corresponding to the provided sync ID, using the provided encrypted bookmarks.

  • id: 32 character alphanumeric ID identifying synced bookmarks.

Post body example:

{
  "bookmarks":"DWCx6wR9ggPqPRrhU4O4oLN5P09onApoAULX4Xt+ckxswtFNds..."
}
  • bookmarks: Encrypted bookmark data salted using secret value.

Response example:

{
  "lastUpdated":"2016-07-06T12:43:16.866Z"
}
  • lastUpdated: Last updated timestamp for updated bookmarks.

Get Last Updated

Get /bookmarks/{id}/lastUpdated

Retrieves an existing bookmark sync's last updated time stamp corresponding to the provided sync ID.

  • id: 32 character alphanumeric ID identifying synced bookmarks.

Response example:

{
  "lastUpdated":"2016-07-06T12:43:16.866Z"
}
  • lastUpdated: Last updated timestamp for corresponding bookmarks.

Service Information

Get Service Information

Get /info

Retrieves information describing the xBrowserSync service.

Response example:

{
  "status":1,
  "message":"",
  "version":"1.0.0",
  "maxSyncSize":204800
}
  • status: Current service status code. 1 = Online; 2 = Offline; 3 = Not accepting new syncs.
  • message: Service information message.
  • version: API version service is using.
  • maxSyncSize: Maximum sync size (in bytes) allowed by the service.