Nestr API

The Nestr api allows manipulation of nests from outside the Nestr application. The api can be used to create an integration with other applications, or to easily add nests from anywhere.

There are 2 flavours of the Nestr api available. The first uses the Api access (api) label in Nestr and allows a user to open up any nest for insertions from anywhere as long as the apiKey of that nest is sent along with the api request.
The second flavour allows any kind of manipulation, retrieval or insert, but uses the login credentials of a user to authorize the actions.

API based on labels

The label based api uses an apiKey that is automatically generated when the Api access (api) label is added to nest. This flavour of the api only supports the HTTP PUT and POST methods and thus only supports inserting new nests.
When inserting new nests, next to giving a nest a title, you can also set other characteristics of the new nest:

...&fieldValues=project->status:Waiting,api->key:test123

{"fieldValues":{"project->status":"Waiting","api->key":"test123"}}

Example (HTTP PUT):
https://app.nestr.io/api/n/[nestId]/New Nest Title?description=Nest+description&labels=api,bug&apiKey=[apiKey]
Example (HTTP POST json):
https://app.nestr.io/api/n/[nestId]/New Nest Title
json payload: {"description":"Nest description","purpose":"Nest purpose","labels":"api,bug","apiKey":"[apiKey]"}

API based on username/password

Advanced users only. Not for the faint of heart.

The full API is only available when you use your normal username and password to login to Nestr. You first need to login via the API and get an authorization token. After that you can use that token to communicate with the full Nestr API.

Logging into the APIYou login to the API via https://app.nestr.io/api/login/ (REST) or by going to /api/authenticate in your browser.

Example:

curl https://app.nestr.io/api/login/ -d "username=test@example.com&password=password"

This will return an authentication token and the userId of the user logging in. Example:

{
  "status": "success",
  "data": {
    "authToken": "7z1Duk73IX5BCuhe6EwRerv_j1xU4ffP8FxUHjuMAGX",
    "userId": "hQ4PXCCzHDH3HDDEz"
  }
}

This should now be used for any subsequent query to the API, by setting the X-User-Id, X-Auth-Token in the headers of the request.
Example:

curl -H "X-Auth-Token: 7z1Duk73IX5BCuhe6EwRerv_j1xU4ffP8FxUHjuMAGX" -H "X-User-Id: hQ4PXCCzHDH3HDDEz" https://app.nestr.io/api/n/DHZL7jdMAftgE8YgB

This request will simply get the nest with ID DHZL7jdMAftgE8YgB.

{
    "_id": "DHZL7jdMAftgE8YgB",
    "parentId": "qsMQNGQbwqTArEnA8",
    "title": "New Nest Title",
    "description": "<p>Nest description</p>",
    "purpose": "test purpose",
    "labels": [
        "bug",
        "project",
        "api"
    ],
    "fieldValues": {
        "project->status": "Current",
        "api->key": "7dZffpOj-bDPBivlrCCAhOFjyo24uSgWYgO6bT037Am"
    },
    "completed": true,
    "properties": {
        "icon": "sitemap",
        "completable": true,
        "color": "#f00",
        "commentable": true
    },
    "createdAt": "2016-01-21T10:51:05.539Z",
    "updatedAt": "2016-01-21T11:44:40.364Z"
}

NOTE: The "title" and "description" fields are rich text fields and could contain HTML codes.

Logging out of the APIYou log out of the API via https://app.nestr.io/api/logout/

Example:

curl https://app.nestr.io/api/logout -X POST -H "X-Auth-Token: 7z1Duk73IX5BCuhe6EwRerv_j1xU4ffP8FxUHjuMAGX" -H "X-User-Id: hQ4PXCCzHDH3HDDEz"

Should return:

{
  "status": "success",
  "data": {
    "message": "You've been logged out!"
  }
}

Using the APIThere are 5 methods you can call on the API to manipulate nests. These are:

See the table under "API based on labels" to see the fields that can be passed into these api end points.