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=person7%40example.com%3A4d9f54ab74ad33736b552ab0f38721ab349750b7d9abe7f83d57285f6875ef86&url=http%3A%2F%2Fnot.found

Headers

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

Query Parameters

auth_token=person7@example.com:4d9f54ab74ad33736b552ab0f38721ab349750b7d9abe7f83d57285f6875ef86
url=http://not.found

Response

Simulated 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=person6%40example.com%3A57809a68622f2a9e79d4d7e40cc051b22ab7a9e8c296c46719b1104eef26d1cf&url=http%3A%2F%2F5.example.com

Headers

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

Query Parameters

auth_token=person6@example.com:57809a68622f2a9e79d4d7e40cc051b22ab7a9e8c296c46719b1104eef26d1cf
url=http://5.example.com

Response

Simulated Response

Status

302

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

Headers

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

Query Parameters

auth_token=person5@example.com:97f2fabae799428f0d651bcfce07f339748dfbdd445c41498608f548098c1b94

Response

Simulated 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=person1%40example.com%3Ad5121d9ce5ab3926d4fa88e0bc1fffa30edb55e20f6edea7cb4fe59327c16e3b

Headers

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

Query Parameters

auth_token=person1@example.com:d5121d9ce5ab3926d4fa88e0bc1fffa30edb55e20f6edea7cb4fe59327c16e3b

Response

Simulated Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "type": "bookmark",
      "id": 1,
      "attributes": {
        "title": "test",
        "description": null,
        "created_at": "2018-02-01T05:12:11.964Z",
        "updated_at": "2018-02-01T05:12:11.964Z",
        "uri": "http://1.example.com",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "links": {
        "self": "http://example.org/api/v1/bookmarks/1",
        "view": "http://example.org/bookmarks/1"
      }
    }
  ],
  "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/3?auth_token=person3%40example.com%3Ab239acb3249a7e0262262a0bd5cc21d66d5c7fac2a8e00bf73cf17cda1074740

Headers

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

Query Parameters

auth_token=person3@example.com:b239acb3249a7e0262262a0bd5cc21d66d5c7fac2a8e00bf73cf17cda1074740

Response

Simulated Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 3,
    "attributes": {
      "title": "test",
      "description": null,
      "created_at": "2018-02-01T05:12:12.638Z",
      "updated_at": "2018-02-01T05:12:12.638Z",
      "uri": "http://2.example.com",
      "tags": [
        "tag3",
        "tag4"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/3",
      "view": "http://example.org/bookmarks/3"
    }
  }
}

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": "person4@example.com:8d986677ff85c26702c4284a504351c3fe349e3e7ac494656e654f8768ae572b",
  "data": {
    "type": "bookmark",
    "id": 4,
    "attributes": {
      "url": "https://bookmark.example",
      "title": "bookmark 1",
      "description": "Something witty",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    }
  }
}

Response

Simulated 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-02-01T05:12:12.848Z",
      "updated_at": "2018-02-01T05:12:13.031Z",
      "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:21a38f4a7e1391ae83260b18d01acffa126b35d4a396aa89c91a006c9f1ccfcc",
  "data": {
    "type": "bookmark",
    "attributes": {
      "url": "https://bookmark.example",
      "title": "bookmark 1",
      "description": "Something witty",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    }
  }
}

Response

Simulated Response

Status

201

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "bookmark",
    "id": 2,
    "attributes": {
      "title": "bookmark 1",
      "description": "Something witty",
      "created_at": "2018-02-01T05:12:12.428Z",
      "updated_at": "2018-02-01T05:12:12.428Z",
      "uri": "https://bookmark.example",
      "tags": [
        "tag 1",
        "tag 2",
        "tag 3"
      ]
    },
    "links": {
      "self": "http://example.org/api/v1/bookmarks/2",
      "view": "http://example.org/bookmarks/2"
    }
  }
}

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=person8%40example.com%3Af6336a4949405ad507e0053e9c9ce0565b82ce1d1e34905b5d7659c197361d64

Headers

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

Query Parameters

auth_token=person8@example.com:f6336a4949405ad507e0053e9c9ce0565b82ce1d1e34905b5d7659c197361d64

Response

Simulated Response

Status

200

Headers

Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "profile",
    "id": 8,
    "attributes": {
      "api_token": "f6336a4949405ad507e0053e9c9ce0565b82ce1d1e34905b5d7659c197361d64",
      "username": "person8",
      "email": "person8@example.com"
    },
    "links": {
      "self": "http://example.org/api/v1/profile"
    }
  }
}