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%3Acdddcee119a214ad52d9e91ab7d0f2760f90e132ad750916b65ff4226a729d7e&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:cdddcee119a214ad52d9e91ab7d0f2760f90e132ad750916b65ff4226a729d7e
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=person5%40example.com%3A81fee880bdb35b5d5f30742e785e92d7d9edac36b7fd8d3c69b940b30d3b305d&url=http%3A%2F%2F2.example.com

Headers

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

Query Parameters

auth_token=person5@example.com:81fee880bdb35b5d5f30742e785e92d7d9edac36b7fd8d3c69b940b30d3b305d
url=http://2.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=person4%40example.com%3A948c0d88ad6becd3d37b9c4b16cfc6019cff51fdce8f45af3e10bc8608fbef8b

Headers

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

Query Parameters

auth_token=person4@example.com:948c0d88ad6becd3d37b9c4b16cfc6019cff51fdce8f45af3e10bc8608fbef8b

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/6

Headers

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

Query Parameters

auth_token=person9@example.com:993f43d7047dab71b91c3b4acdd43908479b56295ab0ca5032cea45981c269e4

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=person3%40example.com%3Aaf3ad312b7a900e4a72b848b2a0e0a45ba6a510cc8fde8feea9f55aacdab5207

Headers

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

Query Parameters

auth_token=person3@example.com:af3ad312b7a900e4a72b848b2a0e0a45ba6a510cc8fde8feea9f55aacdab5207

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "bookmark",
      "id": 2,
      "attributes": {
        "title": "test",
        "description": null,
        "created_at": "2018-07-12T01:10:12.759Z",
        "updated_at": "2018-07-12T01:10:12.759Z",
        "uri": "http://1.example.com",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "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/5?auth_token=person8%40example.com%3A3dabd5d3fec5c7a4b68d0049f1bbf52f2dce8a29b1d60bd3c853d1633702460e

Headers

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

Query Parameters

auth_token=person8@example.com:3dabd5d3fec5c7a4b68d0049f1bbf52f2dce8a29b1d60bd3c853d1633702460e

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 5,
    "attributes": {
      "title": "test",
      "description": null,
      "created_at": "2018-07-12T01:10:14.432Z",
      "updated_at": "2018-07-12T01:10:14.432Z",
      "uri": "http://4.example.com",
      "tags": [
        "tag7",
        "tag8"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/5",
      "view": "http://example.org/bookmarks/5"
    }
  }
}

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/4

Headers

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

Body

{
  "auth_token": "person7@example.com:ecee24370f29ce62011149ba4852a205cec905a45e0904b0b43ff9799d96e1cd",
  "data": {
    "type": "bookmark",
    "id": 4,
    "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": 4,
    "attributes": {
      "title": "bookmark 1",
      "description": "Something witty",
      "created_at": "2018-07-12T01:10:13.844Z",
      "updated_at": "2018-07-12T01:10:14.201Z",
      "uri": "http://3.example.com",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/4",
      "view": "http://example.org/bookmarks/4"
    }
  }
}

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": "person2@example.com:166ac47d0039688bf9074b66c8af2c85c8b910d2ed0f39cc42069c20ef85ca57",
  "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": 1,
    "attributes": {
      "title": "bookmark 1",
      "description": "Something witty",
      "created_at": "2018-07-12T01:10:11.398Z",
      "updated_at": "2018-07-12T01:10:11.398Z",
      "uri": "https://bookmark.example",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/1",
      "view": "http://example.org/bookmarks/1"
    }
  }
}

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%3A3385c179f00b44820a86d28b6641c2145468e2c078aa2c7b793de8d4d23268be

Headers

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

Query Parameters

auth_token=person1@example.com:3385c179f00b44820a86d28b6641c2145468e2c078aa2c7b793de8d4d23268be

Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

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