Stormz

Developer


Stormz API

This website describes the Stormz API.

This API is currently in beta. If you want an early access, please send an email to the support.

Getting started

  1. Ask the support to have an application id and a secret.
  2. See librairies

Overview

The base URL of the API is https://api.stormz.me.

All data must be transmitted over HTTPS and using JSON.

Authentication

To use any of the ressources available, you need to be authenticated. The only available method right now is using OAuth2.

Read more about OAuth.

Cross Origin Resource Sharing

We support CORS, but only for domains authorized. Your Origin must match the domain of the configured redirect_url.

Pagination

Some endpoint support pagination. By defaults these returns only 30 items. Use the per_page parameter to fetch more (up to 100 items).

When there is more items than the number requested, the response will include a Link header with the URLs to use.

The rel value can be first, previous, next or last.

Link: <https://api.stormz.me/v1/user/me/workshops?page=3&per_page=100>; rel="next",
      <https://api.stormz.me/v1/user/me/workshops?page=50&per_page=100>; rel="last"

Errors

In case of errors, the API will return a 4xx request with a JSON body.

Status: 400 Bad Request
{
  "message": "Problems parsing JSON"
}