Eratos Workspace API (v1)

Getting Started

Authentication

The Eratos Workspace API uses Basic Authentication and Bearer Token Authentication to authenticate requests.

Basic Authentication

To authenticate with the Eratos Workspace API using Basic Authentication, an Eratos key and secret is required.

Visit Eratos Workspace: https://workspace.eratos.com/development to generate Eratos credentials

Basic Authentication typically requires a username and password to be sent in the Authorization request header however instead a key and secret is used:

Authorization: Basic key:secret

key:secret is a placeholder that represents a base64 encoded string. Most request libraries will generate a base64 string for you automatically.

Example

To test locally, run the example below replacing your_key and your_secret with your key and secret.

echo -n your_key:your_secret | base64 -w 0
eW91cl9rZXk6eW91cl9zZWNyZXQ=
curl https://api.eratos.com/api/workspace/v1/resources -H \"Authorization: Basic eW91cl9rZXk6eW91cl9zZWNyZXQ=\"

Basic Authentication requires HTTPS to keep the credentials secure while in transit.

Key Concepts:

Identifiers

ern (Eratos Resource Name)
A ERN is a globally unique identifier that identifies a resource within the Eratos ecosystem. It is a structured string that identifies a resource, schema, policy, user, account, or node.
Structure of anern:
- ern:{node}:{type}:{id}
  - {node} - identifies the location or lookup address of a resource. May blank if the resource is not location specific.
  - {type}: - the type of entity this ern represents
    - resource
    - node
    - schema
    - policy
    - user
    - account
  - {id}: - the unique identifier of the ern
    - Either:
      - 24 character alpha-numeric (e.g. XYZABC123456ABCDEF123456)
      - A prefixed custom id (common id) in the form {namespace}.{customer_id}
    - examples:
      - ern:e-pn.io:resource:AAAAAAAAAAAAAAAAAAAAAAAA
      - ern:e-pn.io:resource:eratos.block.test
      - ern::node:e-pn.io
      - ern:e-pn.io:schema:space
      - ern::user:AAAAAAAAAAAAAAAAAAAAAAAA
      - ern::account:AAAAAAAAAAAAAAAAAAAAAAAA

Eratos Entities

resource - Provides structured metadata about a thing or a concept.
- Every resource has the following minimum required properties:
  - @id - the identifying ern of the resource
  - @type - the schema of the resource identified by a schema ern
  - @owner - the owner of a resource identified by an ern. Can be a user or resource ern.
  - @policy - the policy that applies to the resource identified by a policy ern
- Additional properties are defined by the schema of the resource.
schema - Defines the structure of a resource including the properties and constraints.
policy - A set of rules that govern the access to a resource or node
node - Either be a Primary or a Gateway node identified by a node ern
- Primary Node - Provides management of resources, policies, and schemas.
  - Eratos Managed Primary Node: ern::node:e-pn.io
- Gateway Node - Provides access to raw data and additional query processing services.
  - Eratos Managed Gateway Node: ern::node:au-1.e-gn.io
user - A user identified by a user ern
account - An account or billing entity identified by an account ern

Support

For any support-related questions or feature requests, please contact:

Support Team: [email protected]