📄️ Introduction
This documentation only applies to SPACE versions 1.0.0 and later.
📄️ 🚀 Run a SPACE Instance
This guide will walk you through the steps to set up and run your own instance of SPACE. You can choose to run it using Docker for a quick setup or set it up for development purposes.
📄️ 🔑 Retrieve API Key
To interact with SPACE —whether through its API or via its SDKs— you need an organization level API key. This key acts as the authentication token for all requests.
📄️ ➕ Create User
Remember, in SPACE, users are not end-users of your SaaS application, but accounts used to manage permissions, members, services, and other administrative aspects within a SPACE organization.
📄️ ➕ Create Organization
Organizations are the top-level entities in SPACE. They represent your company and act as containers for all related resources, including services, contracts, API keys, etc. All manageable components in SPACE are created within the scope of an organization. Consequently, deleting an organization will permanently remove all associated resources.
📄️ ➕ Create a Service
To create a new service in SPACE, follow these steps:
📄️ ➕ Create a Contract
In SPACE, contracts represent the legal and technical agreements between the SaaS provider (who manages SPACE) and the end users of the SaaS application. They define who the customer is, what are they subscribed to, and how billing is managed.
📄️ ➕ Create a Pricing Version
One of SPACE's most powerful features is its ability to act as a Pricing Version Control System (PVCS).
📄️ 🔄 Manage Users
The Users Management view in SPACE allows administrators to control access by updating roles and credentials of existing accounts.
📄️ 🔄 Manage Members
Each SPACE organization consists of a set of members. These are users associated with the organization who, therefore, have access to its services, contracts, and other resources. However, the actions they can perform depend on their assigned role and permission level.
📄️ 🔄 Manage API Keys
As explained in the Retrieve API Key guide, each organization in SPACE has its own set of API keys that can be managed according to the user's role and permissions. This keys are used to authenticate requests to the SPACE API and SDKs, and allow to perform different operations programatically over the resources of the organization.
📄️ 🔄 Manage Contract Novations
In SPACE, a novation represents a change in an existing contract’s terms without creating a new contract from scratch (refer to What is SPACE? for more information).
📄️ 🔄 Transfer Ownership
If you are an owner of an organization in SPACE, you have the ability to transfer ownership to another member. This can be useful in scenarios such as when the current owner is leaving the company or wants to delegate ownership responsibilities to someone else.
📄️ 🔄 Manage Pricings Availability
Pricings in SPACE can transition between different availability states depending on their lifecycle. This allows providers to evolve their pricing while maintaining traceability of past versions.
📄️ 🗑️ Delete Users
As mentioned in the Manage Users guide, deleting a user is one of the operations available from the Users Management view in SPACE.
📄️ 🗑️ Delete Organizations
SPACE administrators can delete organizations from the Organizations view, accessible from the left sidebar under the ADMIN section.
📄️ 🗑️ Disable Services
Disabling a service in SPACE is a terminal operation that should only be performed when the service is no longer intended to operate.
📄️ 🗑️ Delete Contract
Contracts in SPACE represent the agreements between your SaaS and its end users.