This plugin exposes a write enabled API interface for NodeBB. It is useful if you would like to supplment the built-in read-only API, in order to push items/actions/events to NodeBB.

For example, without this plugin, one can easily retrieve the contents of a post by prefixing api/ to the corresponding route. (e.g. https://community.nodebb.org/api/topic/687/help-translate-nodebb/2).

With this plugin, however, you can create content on NodeBB externally (new topics, new posts, etc), which comes in handy when third-party applications want deeper integration with NodeBB.

Install this plugin via the plugins page in the ACP.

Alternatively:

$ cd /path/to/nodebb/node_modules
$ git clone [email protected]:julianlam/nodebb-plugin-write-api.git

# Then start NodeBB and activate the plugin

• api/v1 Endpoints

1. Install and activate the plugin, reload NodeBB
2. Generate your uid an API token in the ACP page
3. curl -H "Authorization: Bearer {YOUR_TOKEN}" --data "title={TITLE}&content={CONTENT}&cid={CID}" http://localhost:4567/api/v1/topics

Authentication is handled via HTTP Bearer Token, as generated by the Write API. The first token must be generated via the administration page (admin/plugins/write-api), but additional user tokens can be generated using an existing user/master token.

There are two types of tokens:

• A user token is associated with a specific uid, and all calls made are made in the name of that user
• A master token is not associated with any specific uid, though a _uid parameter is required in the request, and then all calls are made in the name of that user. This is the only difference between the two tokens. A master token with _uid set to a non-administrator will not allow you to make administrative calls.

When the API encounters an error, it will do it's best to report what went wrong. Errors will follow the format specified in this example:

{
    "code": "not-authorised",
    "message": "You are not authorised to make this call",
    "params": {}
}

• users/ routes now take a uid instead of a userslug. This affects the following routes:
  • PUT /api/v1/users/:userslug -> PUT /api/v1/users/:uid
  • POST /api/v1/users/:userslug/follow -> POST /api/v1/users/:uid/follow
  • DELETE /api/v1/users/:userslug/follow -> DELETE /api/v1/users/:uid/follow