Hub API reference

We will ultimately build R/python packages to query these servers, so we need a standard API to do so.

Overview

This describes the resources that make up the EPISB REST API v1. For questions or issues please visit discourse.episb.org.

General Information

  1. Current Version
  2. Schema
  3. Authentication
  4. HTTP Verbs
  5. Pagination
  6. User agent required
  7. Rate Limiting

Endpoints

  1. Regions

Current Version

Currently the EPISB API is at v1. In future releases, all efforts will be made to provide backward compatibility. The deprecation of previous API versions is unlikely.

Hostname and Base Path

API access is provided over HTTPS and is accessible from https://episb.org/api/. All data sent to and received from this API is in JSON.

https://episb.org/api/

Authentication

Not currently implemented. However, API authentication using a registered token will be required at some point in the future.

HTTP Verbs

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin tincidunt viverra elit vitae mollis. Donec ipsum erat, ornare id suscipit non, lobortis

Pagination

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin tincidunt viverra elit vitae mollis. Donec ipsum erat, ornare id suscipit non, lobortis

User agent required

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin tincidunt viverra elit vitae mollis. Donec ipsum erat, ornare id suscipit non, lobortis

Rate Limiting

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin tincidunt viverra elit vitae mollis. Donec ipsum erat, ornare id suscipit non, lobortis

Regions