Create an account and save your credentials

Register with BigState and collect the credentials required by the API and tutorials.

Create your account

Register through the BigState Dashboard or the Sign in link on this site.

Save the Welcome values

Copy your owner, API key, public key, and private key before leaving the page.

Start building

Use the owner to name resources and the API key to authenticate requests.

How onboarding works#

Account registration and API access are two connected steps:

Dashboard or website → BigState authentication → Welcome page → saved credentials

The authentication service creates your account. After registration, BigState redirects you to a one-time Welcome page containing the credentials for your new owner.

Save every value before leaving the Welcome page

The initial credentials are not available for self-service retrieval later.

Store the owner, API key, public key, and private key in a secure credential manager. If you lose them after leaving the Welcome page, contact BigState Support.

Create your account#

  1. Open the BigState Dashboard, or open the BigState website and select Sign in in the header.
  2. On the authentication page, select Create one under “Don't have an account?”.
  3. Enter your email and password on the Create your account page.
  4. Select Create account.
  5. After registration completes, wait for the redirect to the BigState Welcome page.

If you already have an account, use Sign in instead. Registration is required only once.

Save the Welcome credentials#

The Welcome page displays four values:

Owner

Your BigState namespace. It becomes part of fully qualified object names.

API key

A secret credential used to authenticate HTTP and delivery client requests.

Public key

The shareable half of the generated key pair.

Private key

The secret half of the generated key pair. Store it with the same care as an API key.

Copy all four values exactly as displayed. Do not store the API key or private key in source code, screenshots, chat messages, or application logs.

The owner and public key identify resources and credentials; they are not secret values. The API key and private key grant access and must remain private.

Use your owner#

BigState object names include the owner after @:

simple:counter@YOUR_OWNER

forex:eurusd@YOUR_OWNER

Replace YOUR_OWNER with the exact owner value from the Welcome page. Publisher and subscriber applications must use the same fully qualified object name to address the same state.

Use your API key#

Send the API key in the x-api-key request header:

curl "https://api.bigstate.dev/v1/object/match?next=0&pattern=*" \

  --header "x-api-key: YOUR_API_KEY" \

  --header "Accept: application/json"

Replace YOUR_API_KEY without adding extra quotes to the stored value.

Checkpoint: a successful request returns a JSON page of objects visible to the key. A 401 response usually means the key is missing or invalid; 403 means the key is valid but does not have access to that operation or resource.

Create additional API keys#

After signing in to the Dashboard:

  1. Open the API keys tab.
  2. Create a key for the application or service that will use it.
  3. Copy the new secret when it is displayed.
  4. Store it securely and give each environment only the key it needs.

For programmatic key management, use Create an API key, List API keys, and Delete an API key. Creating a key through the API requires an existing authorized API key.

If you lose the initial credentials#

The initial Welcome values cannot be retrieved through self-service onboarding after you leave the page. Contact BigState Support and include the email address used for registration. Never send an API key or private key in a support message.

Next steps#

Getting startedJavaScript

© 2024 BigState