docs
api  ·  platform  ·  guides
API Documentation
Introduction

Getting Started

Authentication

Libraries

Error Messages


Users

GET users/:username

GET users/:username/followers

GET users/:username/following

GET users/:username/hubs

GET users/:username/projects


Hubs

GET hubs/:uniquename

GET hubs/:uniquename/followers

GET hubs/:uniquename/members

GET hubs/:uniquename/projects


Projects

GET projects/:id

GET projects/:id/files

GET projects/:id/contributors


Files

GET files/:id

GET files/:id/data

PATCH files/:id

Datazar API Introduction

Getting Started

Welcome to the Datazar API! The API allows you to access any object data and any dataset. You can use the API to either build external applications or stream the datasets directly. Refer to the object specific documentation to know exactly how to obtain the information. All API requests require a token. Read the Authentication section to obtain a token.

Authentication

Obtaining a Token

To obtain an access token, you'll need a Datazar account. Please navigate to https://www.datazar.com/signup to signup. How to guides on how to sign up can be found here. Once you have created your account, click on the "API" section on your main navigation located on the right side of the page. Click the Create Token button and name your token for future references if you end up creating multiple tokens. When you confirm the token creation, you will be shown the secret key. This is the only time the secret is available so store it somewhere safe as you'll need it to authenticate the API.

Through out this documentation, we'll be using curl so you can follow along on your terminal.

Authenticating

Once you obtain the via the interface, you have to retrieve a request key using the API. This key will be used on every API call you make.

Request

curl https://api.datazar.com/auth/<key> \
-X GET

Reponse

{
    "token":"sometokenyoullgetfromtheserver"
}

Libraries

Official libraries for the API can be found on the following links:

Error Messages

Error messages will be thrown if the authentication key is wrong, object does not exist or if they authenticated user does not have permission.

"error":{
  "message": "authentication failed",
}