API Reference
WebsiteDiscordBlog

Overview

Ways to Connect

We understand that some developers want to manage their own private keys, and others would rather opt for a more streamlined approach. In order to satisfy all use cases, we offer two distinct ways that you can connect to Space and Time:

  1. Connect to the Gateway (Secrets Proxy): Delegated custody to our secure servers for a simpler, Web2-style developer experience. Use our Gateway (Secrets Proxy) APIs.
  2. Connect Directly to the Space and Time Network: Self-custodied secrets for optimal performance, flexibility, and decentralized Web3 security. Use all other APIs.

To learn more about both ways to connect, visit this page.

About the Gateway (Secrets Proxy) APIs

The Gateway (Secrets Proxy) APIs are a specialized subset of the Space and Time REST APIs that allow users to more easily interact with the security components of the SxT platform. The Gateway sits outside of the core network and provides custodial secrets management (including ED25519 public/private key pair for authentication and biscuit private keys for biscuit management).

Using the Gateway (Secrets Proxy) API, you can do the following:

  • Authenticate with Web2 username/password and let the Gateway handle the ED25519 authentication with the network on your behalf.
  • Create new resources and have valid biscuits and public keys provided for you.
  • Configure permissions on those resources for users in your subscription and have the Gateway automatically generate biscuits for them.
  • Upload your own biscuits to the Gateway.
  • Generate API keys and use the proxy APIs to interact with the platform without needing to perform explicit authentication or authorization - the proxy will handle it all for you!

The Space and Time Studio already has first-class integration with the Gateway, so you won't have to manually enter biscuits every time you want to execute a query (they'll be automatically injected as needed). JDBC Driver integration is coming soon, which will enable users to authenticate with the platform using the same username/password as they do in the dapp. It will also enable users to have their configured biscuits loaded into the driver for them automatically, so they won't have to be manually configured.

About our other APIs

If you want to connect directly to the Space and Time network, you can get connected with the Security/Auth REST APIs and use any of the APIs in that section and below.