API for Review Links

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 REST resources available in the zipBoard platform, along with the expected HTTP response codes and sample requests for interacting with zipBoard Review Links.

Before you start working with the API, you will need to generate an API key and also get an idea of the URI Structure that needs to be followed. Please follow this article for more information on that.

Get Review Links 

GET https://app.zipboard.co/api/v1/shareurl

• To get the corresponding review link for projects and files, for your collaborators and guest collaborators.

HEADERS

Content-Type                          application/json

Authorization                          Authorization token

URL Params
        Required:

None

        Optional:

None

Body Prams

        Required:

                At least one is required from optional Body Params.

        Optional:

                     projectid                String                                              id of the project to get review links of that project 

                fileid                      String                                              id of the project to get review links of that project 

Request

var http = require('http');
Http.request({
   method: 'GET',
   url: `https://app.zipboard.co/api/v1/shareurl`,
   body: {
         projectid: “hoPjX5nfZomWKPsiw”  
   },
})

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Successfully retrieved short url.",
    "data": [
        {
            "fileId": "9JBNNSuGKLvGsvuhE",
            "linkAccess": "view",
            "linkTokenId": "69170a8348122074b6a6e554",
            "shareLink": "http://localhost:3000/s/fA47X",
            "loginRequired": false,
            "users": [],
            "message": "In this url user can view previous tasks and boards."
        },
        {
            "fileName": "google.com",
            "fileId": "9JBNNSuGKLvGsvuhE",
            "linkAccess": "reviewboard",
            "shareLink": "http://localhost:3000//hoPjX5nfZomWKPsiw/9JBNNSuGKLvGsvuhE/reviewboard",
            "loginRequired": true,
            "message": "Url accessible to internal collaborators only;"
        }
    ]
}

Delete Review Link

DEL https://app.zipboard.co/api/v1/shareurl/:id

• Deletes the existing shareurls for the file or project, data required (tokenId for shareurl).
• To delete sharelink the project role of the current user should be Owner or Manager or reviewer or should be current project owner.
• Return success message on link delete.

HEADERS

Content-Type                         application/json

Authorization                          Authorization token

URL Params
        Required:

id:                           String                                               linkTokenId to delete a Review Link

        Optional:

None

Request

var http = require('http');
Http.request({
   method: 'DELETE',
   url: `https://app.zipboard.co/api/v1/shareurl/661251867f163dcd55344c08`,
});

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Short url successfully deleted."
}

Create Review Link 

POST https://app.zipboard.co/api/v1/shareurl/

• Creates new shareurl for the file, data required (projectId, fileid, type, secure).
• To add a sharelink to the project, the role of the current user should be ‘Owner’ or ‘Manager or ‘Reviewer’ or should be the current project owner.
• Returns the newly created sharelink.

HEADERS

Content-Type                         application/json

Authorization                          Authorization token

URL Params
        Required:

None

        Optional:

                None

Body Prams

        Required:

                projectid                   String                                           id of the project

fileid                          String                                           id of the file

                type                          String                                           type of link (view&comment, fresh, viewonly)

secure                      Boolean                                        true to allow user to signup before review

        Optional:

None                  

Request

var http = require('http');
Http.request({
   method: 'POST',
   url: `https://app.zipboard.co/api/v1/shareurl`,
   body: {
        "projectid": "h7JGWE5Rcd3coiFkY",
	"fileid":"Nzjv8Zj3CYki83s8E",
	"type":"viewonly",
	"secure":false
   },
 });

Response

{
    "status": "Success",
    "status code": 201,
    "data": [
        {
            "fileId": "Nzjv8Zj3CYki83s8E",
            "projectId": "h7JGWE5Rcd3coiFkY",
            "linkAccess": "shareviewonly",
            "linkTokenId": "73b1c69413bb3371c0529666",
            "shareLink": "http://localhost:3000/s/2Sp43",
            "loginRequired": false,
            "clicks": 0,
            "message": "In this url user can view previous tasks and boards."
        }
    ]
}

If you have any questions, you can check out our Forum.