transientBug API Documentation

v1 API

Introduction

The v1 API tries to conform to JSON-API v1.0 format.

Exceptions:

Additionally, this document is generated from acceptance tests using JSON Schemas so it should always be up to date with the current API.

Issues

Issues with the API should be reported on Github. Please check to make sure that the issue you are reporting does not already have an issue created, as to help my sanity when managing them.

Authentication

The transientBug v1 API uses HTTPS and provides several methods of authentication, depending on the use case: Third Party Clients and Personal Tools.

Third Party Client OAuth2

Third Party Clients are defined as mass distributed clients, such as native applications, browser extensions and web apps. For these clients, OAuth2 Authorization Code Grant flow is provided.

Developers can register new OAuth2 applications here, for now you’ll need a minumum of a name and redirect url and will be provided a CLIENT_ID and CLIENT_SECRET which you will use below.

To obtain an access token, first make a GET request to /oauth/authorize:

/oauth/authorize?client_id=CLIENT_ID
  &redirect_uri=REDIRECT_URL
  &response_type=code

where CLIENT_ID is the client ID provided when registering the application, and REDIRECT_URL is the same redirect url you used when registering the application.

On a successful call, this will redirect to the REDIRECT_URL with a code in the query string. With that code, issue a POST to /oauth/token:

/oauth/token?client_id=CLIENT_ID
  &client_secret=CLIENT_SECRET
  &code=RETURNED_CODE
  &grant_type=authorization_code
  &redirect_uri=REDIRECT_URL

where CLIENT_SECRET is the value provided after registering your app, and RETURNED_CODE is the code from the first requests redirect. A successful request will return a JSON payload with an access_token key.

After this, you can begin using the API, with all requests containing the access_token in an Authorization Bearer header: Authorization: Bearer <access_token>

Personal Tools

For Personal Tools, small scale applications and other utilities developed for personal use, two simple methods are provided, modeled off of the Pinboard v1 API with the intention of trying to be easy to use and develop against:

  • HTTP Basic Auth: https://<email>:<password>@transientbug.ninja/api/v1/<method>
  • Query String API Tokens: https://transientbug.ninja/api/v1/<method>?auth_token=<email>:<auth_token>

The query string API token can also be sent along in the JSON body for POST, PATCH and PUT requests.

You are encouraged to only use Basic Auth to grab the API token through the profile endpoint, and should prefer to use the API token method everywhere to avoid storing your password.

You can find your API token on your profile page. Through this page you can also regenerate your token, however this will invalidate your previous API token.

v1 Bookmarks

Check for a non-existent bookmark

Endpoint

GET /api/v1/bookmarks/check

Parameters

Name Description
auth_token Required Authentication Token
url Required URL to check

Request

Route

GET /api/v1/bookmarks/check?auth_token=person6%40example.com%3A1a6d52f040c2482d88058d52415ebd045a3b3c8eb668de3d963939177a35ca5d&url=http%3A%2F%2Fnot.found

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person6@example.com:1a6d52f040c2482d88058d52415ebd045a3b3c8eb668de3d963939177a35ca5d
url=http://not.found

Response

Status

404

Headers

Content-Type: application/vnd.api+json

Check for an existing bookmark

Endpoint

GET /api/v1/bookmarks/check

Parameters

Name Description
auth_token Required Authentication Token
url Required URL to check

Request

Route

GET /api/v1/bookmarks/check?auth_token=person9%40example.com%3A4bb04cc1baf23f7315873cd38d86a65162268d7dee38c657dbaf978a73dd2b5c&url=http%3A%2F%2F5.example.com

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person9@example.com:4bb04cc1baf23f7315873cd38d86a65162268d7dee38c657dbaf978a73dd2b5c
url=http://5.example.com

Response

Status

302

Headers

Content-Type: application/vnd.api+json

Check with no URL

Endpoint

GET /api/v1/bookmarks/check

Parameters

Name Description
auth_token Required Authentication Token

Request

Route

GET /api/v1/bookmarks/check?auth_token=person3%40example.com%3A4c8d1d4b987bc32ec46ad4ba6bf8b55abbae21923268c08311061d4839e3e0f7

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person3@example.com:4c8d1d4b987bc32ec46ad4ba6bf8b55abbae21923268c08311061d4839e3e0f7

Response

Status

400

Headers

Content-Type: application/vnd.api+json

Delete a bookmark

Endpoint

DELETE /api/v1/bookmarks/:id

Parameters

Name Description
auth_token Required Authentication Token
id Required Bookmark ID

Request

Route

DELETE /api/v1/bookmarks/1

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person2@example.com:6dc7d3cea2ab609199c96edcb46f3afdab5ad8466d4b4851e73bbd9c47324747

Response

Status

204

Headers

Get All Bookmarks

Endpoint

GET /api/v1/bookmarks

Parameters

Name Description
auth_token Required Authentication Token

Request

Route

GET /api/v1/bookmarks?auth_token=person4%40example.com%3A37fc659ac767c0dc460a654dbcafdcf5addde34949c9ec73bcd53e5691b1be40

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person4@example.com:37fc659ac767c0dc460a654dbcafdcf5addde34949c9ec73bcd53e5691b1be40

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "bookmark",
      "id": 2,
      "attributes": {
        "title": "test",
        "description": null,
        "created_at": "2018-08-27T20:46:52.795Z",
        "updated_at": "2018-08-27T20:46:52.795Z",
        "uri": "http://2.example.com",
        "tags": [
          "tag3",
          "tag4"
        ]
      },
      "links": {
        "self": "http://example.org/api/v1/bookmarks/2",
        "view": "http://example.org/bookmarks/2"
      }
    }
  ],
  "links": {
    "self": "http://example.org/api/v1/bookmarks?page=1",
    "first": "http://example.org/api/v1/bookmarks?page=1",
    "prev": null,
    "next": null,
    "last": "http://example.org/api/v1/bookmarks?page=1"
  },
  "meta": {
    "count": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Get a Bookmark

Endpoint

GET /api/v1/bookmarks/:id

Parameters

Name Description
auth_token Required Authentication Token
id Required Bookmark ID

Request

Route

GET /api/v1/bookmarks/4?auth_token=person7%40example.com%3A37d7bbcf2d5e632b155d13f4e57aa612903ed4d902f3a0ad2423192d2ad56835

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person7@example.com:37d7bbcf2d5e632b155d13f4e57aa612903ed4d902f3a0ad2423192d2ad56835

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 4,
    "attributes": {
      "title": "test",
      "description": null,
      "created_at": "2018-08-27T20:46:54.222Z",
      "updated_at": "2018-08-27T20:46:54.222Z",
      "uri": "http://3.example.com",
      "tags": [
        "tag5",
        "tag6"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/4",
      "view": "http://example.org/bookmarks/4"
    }
  }
}

Update a Bookmark

Endpoint

PATCH /api/v1/bookmarks/:id

Parameters

Name Description
auth_token Required Authentication Token
id Required Bookmark ID
data.type Required bookmark
data.id Required Bookmark ID to update
data.attributes.url Required Bookmarks URL
data.attributes.title Required Title
data.attributes.description Description/Note
data.attributes.tags Comma separated

Request

Route

PATCH /api/v1/bookmarks/5

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Body

{
  "auth_token": "person8@example.com:3184dbc9b7e56d4657105f45da9c8b0bf0cc161e1a159da09c0d7c37bcd04dca",
  "data": {
    "type": "bookmark",
    "id": 5,
    "attributes": {
      "url": "https://bookmark.example",
      "title": "bookmark 1",
      "description": "Something witty",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    }
  }
}

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 5,
    "attributes": {
      "title": "bookmark 1",
      "description": "Something witty",
      "created_at": "2018-08-27T20:46:54.656Z",
      "updated_at": "2018-08-27T20:46:55.024Z",
      "uri": "http://4.example.com",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/5",
      "view": "http://example.org/bookmarks/5"
    }
  }
}

Upsert a Bookmark

Endpoint

POST /api/v1/bookmarks

Parameters

Name Description
auth_token Required Authentication Token
data.type Required bookmark
data.attributes.url Required Bookmarks URL
data.attributes.title Required Title
data.attributes.description Description/Note
data.attributes.tags Comma separated

Request

Route

POST /api/v1/bookmarks

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Body

{
  "auth_token": "person5@example.com:0aa745c2b282e31eac19430b69f13275a239dc943a4fc95a0c1f1bb6fb294f67",
  "data": {
    "type": "bookmark",
    "attributes": {
      "url": "https://bookmark.example",
      "title": "bookmark 1",
      "description": "Something witty",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    }
  }
}

Response

Status

201

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 3,
    "attributes": {
      "title": "bookmark 1",
      "description": "Something witty",
      "created_at": "2018-08-27T20:46:53.392Z",
      "updated_at": "2018-08-27T20:46:53.392Z",
      "uri": "https://bookmark.example",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/3",
      "view": "http://example.org/bookmarks/3"
    }
  }
}

v1 Profile

Get

Fetch the users profile information, including their api_token and email used to build the auth_token.

Endpoint

GET /api/v1/profile

Parameters

Name Description
auth_token Required Authentication Token

Request

Route

GET /api/v1/profile?auth_token=person1%40example.com%3A7bcc468b2d3ab706e92cf2e16eb3883c7eb4366dcd7db5c0162574d5b1bfb449

Headers

Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Query Parameters

auth_token=person1@example.com:7bcc468b2d3ab706e92cf2e16eb3883c7eb4366dcd7db5c0162574d5b1bfb449

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "profile",
    "id": 1,
    "attributes": {
      "api_token": "7bcc468b2d3ab706e92cf2e16eb3883c7eb4366dcd7db5c0162574d5b1bfb449",
      "username": "person1",
      "email": "person1@example.com"
    },
    "links": {
      "self": "http://example.org/api/v1/profile"
    }
  }
}