Bloctopus API
Overview
The Bloctopus API is a family of smaller APIs that each focus on an individual aspect of our platform. They have their own set of endpoints, entities, paradigms, versions and depreciation policies.
Authentication
When requesting a secured API endpoint, you must include an API token in the Authorization
header:
curl --request GET \
--url "https://apis.bloctopus.io" \
--header "Authorization: YOUR-TOKEN" \
Failure to provide a valid API token will result in the server responding with 401 Unauthorized
.
Authorization
Where applicable, an API endpoint may perform authorization. Decisions are made based on preconfigured permissions for a user or service account. Trying to access a resource without a valid permission will result in the server responding with 403 Forbidden
or 404 Not Found
. Permissions are managed at the workspace level using the Workspace API.
APIs
Network API
Base URL: https://apis.bloctopus.io/network
The Network API is a low-level API that provisions and manages blockchain networks.
Workspace API
Base URL: https://apis.bloctopus.io/workspace
The Workspace API manages cross-cutting concerns in your workspace, such as invitations, memberships, permissions.
Token Manager
Base URL: https://apis.bloctopus.io/token-manager
The Token Manager deploys and manages standard tokens to your networks.