Skip to main content

Get started with Star Community API

Before you start​

Make sure you register your planned integration with the Hubble Board. They will approve or deny your request for integration, find any missing API endpoints and may ask for additional motivation, storyboards or wireframes to be submitted to process your request.

The following endpoints are in use:

  • Production: https://api.starcommunity.app (not yet live)
  • Test: https://api.test.starcommunity.app

The API is detailed with an OpenAPI spec, available at OpenAPI yaml file, and rendered at API Endpoints.

Requesting data​

Every request to the API must be authenticated and authorized.

This can either be:

For authentication, we use the OpenID Connect protocol. The token received from the Authorization Server must be put in the Authorization header of your HTTP request. For example, if you receive token ABCDEF, this would be:

Authorization: Bearer ABCDEF

Every request you make to the API must include this header.