JetBrains SpaceCode Preview Help

SpaceCode HTTP API

SpaceCode HTTP API lets you programmatically access any part of the SpaceCode: Projects, Repositories, User Profiles, and so on. For details on performing particular API requests, refer to the the API Playground (see below).

To quickly get started with the HTTP API, use the SpaceCode SDK.

API Playground

API Playground lets you:

  • Explore the SpaceCode API endpoints.

  • Create HTTP API requests for various tools and languages.

  • Run the requests on behalf of SpaceCode accounts created by you.

API Playground

To open API Playground

  1. On the top right, click your avatar and choose Administration:

  2. Scroll down the left sidebar and choose API Playground:

    chooseHTTPAPIPlayground.png

Accessing the SpaceCode API

There are two ways of accessing the SpaceCode API: through the OAuth 2.0 protocol (recommended) or by using a personal token. Learn more

SpaceCode API clients

Almost all of the modern programming languages/frameworks support running HTTP requests and handling responses. Using the API in this way – by "manually constructing" API requests is complicated and not effective. The right way is using an API client – a set of libraries that hide the low-level complexity of making the requests.

SpaceCode provides two API clients: for Kotlin/Java and for .NET. When using a client, you work with high-level entities – classes that represent particular SpaceCode modules. The clients are a part of SpaceCode SDK. Learn more

If you need a client for some other programming language, you can create it by using the OpenAPI Specification (formerly Swagger Specification). To download the SpaceCode OpenAPI specification, open API Playground and click Download OpenAPI in the bottom left corner.

Last modified: 27 May 2024