GET /info
info of the environment

Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'version': 'test:test'
}

Params

Param name Description
timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


GET /minutes
Show minutes for an institute

Errors

Code Description
404 Couldn't find Institute with 'id'=':id'
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'from': '1527500365',
    'to': '1555506695'
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'minutes':{
      '2018-01-01':0,
      '2018-02-01':35,
      '2018-03-01':220,
      '2018-04-01':0,
      '2018-05-01':35,
      '2018-06-01':55,
      '2018-07-01':60,
      '2018-08-01':65,
      '2018-09-01':75,
      '2018-10-01':85,
      '2018-11-01':95,
      '2018-12-01':135}
    }
}

Params

Param name Description
from
required

in seconds

Validations:

  • Must be a number.

to
required

in seconds

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String