Blockspring API Documentation (Beta - v0)

This repository contains the documentation for the Blockspring API.

• Authentication
• HTTP API
  • Basics
  • JSONP
  • CORS
• Endpoints
  • Test
  • User
  • Favorites
  • Tags
  • Organizations
• Executing Blocks
• Javascript SDK

Authentication

Blockspring uses OAuth2 for authenticating applications.

View the Authentication Documentation

Manage your apps: Developer App Dashboard

HTTP API

Basics

• API Base URL: https://api.blockspring.com/v0/
• Response format: json
• Request Authentication: Making Authenticated Requests

JSONP

The Blockspring v0 API supports JSONP for GET requests. Add a callback query string parameter to requests:

Request

https://api.blockspring.com/v0/me?callback=myfunction

Response

/**/myfunction({
  "meta": {
    "status": 200,
    "X-Blockspring-API-Version": "v0"
  },
  "data": {,
    "id": 3,
    "username": "jtokoph",
    "name": "Jason Tokoph",
    "favorites_url": "https://api.blockspring.com/v0/favorites?access_token={access_token}",
    "url": "https://api.blockspring.com/v0/me?access_token={access_token}",
    "organization": {
      "subdomain": "blockspring",
      "name": "Blockspring",
      "url": "https://api.blockspring.com/v0/organization?access_token={access_token}"
    }
  }
})

CORS

The Blockspring API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin.

Endpoints

Test

Endpoints for testing API clients and access tokens.

Method	Endpoint	Description
GET	/v0/marco	Test simple GET request. Replies 200 "POLO!"
POST	/v0/echo	Test simple POST request. Replies 200 with payload you send.

User

Endpoints for getting User information.

Method	Endpoint	Description
GET	/v0/me	Get user information for access token

Favorites

Endpoints for getting a user's favorite blocks.

Method	Endpoint	Description
GET	/v0/favorites	Get user's favorite blocks

Tags

Endpoints for getting tags on Blockspring.

Method	Endpoint	Description
GET	/v0/tags	Get official Blockspring tags
GET	/v0/tags/:tag_id	Get tag and blocks with that tag

Blocks

Endpoints for getting block info.

Method	Endpoint	Description
GET	/v0/blocks/:block_id	Get block metadata

Organizations

Endpoints for getting tags on Blockspring.

Method	Endpoint	Description
GET	/v0/organizations	Get information about the current user's organization
GET	/v0/organizations/tags	Get an organization's tags

Executing Blocks

Blocks are executed via another system at https://run.blockspring.com instead of https://api.blockspring.com.

Authentication for running blocks is done with the same access_token retrieved via OAuth.

View the Block Execution documentation

Javascript SDK

The Blockspring Javascript SDK allows your website to interact with the Blockspring platform with a simple to use interface. It currently only supports opening a block form window for users to test and preconfigure block runs. More information can be found on the Javascript SDK page

Changelog

You can view the changelog in CHANGELOG.md

Terms of Service

Please review our Terms of Service.