API Authentication and URI Structure
Welcome to the zipBoard platform REST API reference. This API is essential for connecting remotely with zipBoard, regardless of whether you are building an application, scripting interactions with zipBoard or building some other integration.
This page documents the process of API key generation and the URL Structure that is followed by the API.
Generating/Refreshing API Key
The authentication method for the zipBoard API is HTTP token authentication (when using SSL).
Accessing your zipBoard
Here are the steps that you need to take in order to access your token:
- Sign in to your
zipBoard account. - Click your name at the top right corner of the screen and select 'Edit Profile' from the dropdown menu.
- Now click on the 'refresh' icon to generate your own zipBoard API key!
URl Structure
zipBoard REST APIs provide access to resources (that is, data entities) via URI paths. To use the REST API, your application makes an HTTP request and parses the response.
The zipboard REST API uses JSON as its communication format and standard HTTP methods like GET, PUT, POST, and DELETE. URIs for zipBoard REST API resource has the following structure:
http://host/api-name/api-version/resource-name
As an example, if you wanted to retrieve the JSON representation of an issue from zipBoard, you would access:
https://app.zipboard.co/api/v1/issues/tasks/:id
If you have any questions, you can check out our Forum.