Spanrr
Search…
Spanrr API
Description and specification of all APIs offered by Spanrr

Getting Started

Spanrr provides all its functionality in an idiomatic REST API. All requests and responses are JSON encoded. All endpoints start with the following url: https://api.spanrr.com/v1/
Users are requested to limit API requests to 60 per minute. Beyond that that there might be API rate limiting applied depending upon resource availability. Do let us know if you think you will need more utilization.

Authorization

All the APIs require an authorization token. This token can be generated by using Authorization Token endpoint. Include the Authorization Token in requests as follows:
Authorization: Bearer <TOKEN_VALUE>
Note: There is a space after the word "Bearer".

Error Handling

All successful requests have 2XX HTTP status code in the response. Client side error will respond with 4XX errors and Server side errors will respond with 5XX errors. In addition error responses will return a JSON object with "error" attribute with more information for the failure. For example:
1
{
2
"error": "Resource not Found"
3
}
Copied!

Authorization

This section describes how to perform authorization required to access APIs. You will need to generate a token using Generate Token API and use it all requests as follows:
Authorization: Bearer <TOKEN_VALUE>
post
https://api.spanrr.com
/v1/token/
Generate Token

Projects

All the Spanrr workflows happen inside Projects. You can create and access any number of Projects to organize different separate work areas. These APIs allow you create access and manage projects. All other objects are child of Project. So all other endpoints need to specify the hash of the project that they are trying to access in the URL as follows:
/v1/projects/:hash
The hash of the project can be obtained at the time of creation via Create Project API or via Get All projects A
post
https://api.spanrr.com
/v1/projects/
Create Project
get
https://api.spanrr.com
/v1/projects/
Get All Projects
get
https://api.spanrr.com
/v1/projects/:hash
Get Project

Tables

Tables store all the data that you enter on Spanrr. All tables belong to a project. All the endpoints in the table resource require you to know the hash of the project the table belongs to. You can get the hash from Get All Projects API. You can save/cache the hash for repeated invocations as it never changes after creation of project.
The tableName is used as a parameter in other resources. Table Name can be obtained by using Get Tables endpoint. All objects that are children of table (like rows and columns) need to specify the tableName in the endpoint as follows:
/v1/projects/:hash/tables/:tableName
post
https://api.spanrr.com
/v1/projects/:hash/tables/
Create Table
get
https://api.spanrr.com
/v1/projects/:hash/tables/
Get Tables
get
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName
Get Table

Columns

Columns define each of the individual columns in a table. You can add remove and modify the columns using these APIs. You will have to specify the hash and tableName for each operation. Some of the operations might require you to specify the name of the column. This can be received from the Get All Columns API. This is the general form of all the URL for API endpoints for Columns:
/v1/projects/:hash/tables/:tableName/columns/:columnName
post
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/columns/
Add Column
get
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/columns/
Get All Columns
get
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/columns/:columnName
Get Column
patch
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/columns/:columnName
Update Column
delete
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/columns/:columnName
Delete Column

Rows

All the data for the table is retained in individual rows. Each row object is a child of the table. You will have to specify the hash and tableName for each operation. Some of the operations will require you to specify rowId. This can be received from the Get All Rows API. The "id" attribute on the row object is referred to as rowId throughout the documentation. This is the general form of all the URL for API endpoints for Rows:
/v1/projects/:hash/tables/:tableName/rows/:rowId
post
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/rows/
Add Row
get
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/rows/
Get All Rows
get
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/rows/:rowId
Get Row
patch
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/rows/:rowId
Update Row
delete
https://api.spanrr.com
/v1/projects/:hash/tables/:tableName/rows/:rowId
Delete Row
Last modified 6mo ago