<commit_before>---
layout: doc
title: Getting started
rank: 1
---

#### Getting started

Documentation is divided into 

- The User's Guide: a step by step guide to learn the basics of the SpaceDog backend services using code examples extensively.
- The Reference Guide: the complete reference documentation of all the SpaceDog backend services, parameters, object structures, ...

#### Sign up

First, [sign up](/console.html) to the SpaceDog platform. Provide

- the account administrator username, password and email address,
- the backend id wich will identify all API requests to this backend.

Once signed up, the administrator is granted access to administration console and can manage account settings and backend data. The console also provides the backend API keys used to access the SpaceDog API. See below.

#### Security

SpaceDog **application** services are only accessible over HTTPS (to forbid any forgery) to applications providing a `x-spacedog-backend-key` header with the key an account administrator can get from the SpaceDog [administration console](/console.html).

For example, if the GetMePizza iOS application want to get data from its `getmepizza` SpaceDog backend, it will send an HTTPS request like this one:

```http
GET /v1/data/<commit_msg>Fixes one documentation bad link<commit_after>---
layout: doc
title: Getting started
rank: 1
---

#### Getting started

Documentation is divided into 

- The User's Guide: a step by step guide to learn the basics of the SpaceDog backend services using code examples extensively.
- The Reference Guide: the complete reference documentation of all the SpaceDog backend services, parameters, object structures, ...

#### Sign up

First, [sign up](/sign-up.html) to the SpaceDog platform. Provide

- the account administrator username, password and email address,
- the backend id wich will identify all API requests to this backend.

Once signed up, the administrator is granted access to administration console and can manage account settings and backend data. The console also provides the backend API keys used to access the SpaceDog API. See below.

#### Security

SpaceDog **application** services are only accessible over HTTPS (to forbid any forgery) to applications providing a `x-spacedog-backend-key` header with the key an account administrator can get from the SpaceDog [administration console](/console.html).

For example, if the GetMePizza iOS application want to get data from its `getmepizza` SpaceDog backend, it will send an HTTPS request like this one:

```http
GET /v1/data/
{'fraction_non_alphanumeric': 0.06432748538011696, 'fraction_numerical': 0.0015594541910331384, 'mean_word_length': 4.602620087336245, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3005067', 'n_tokens_mistral': 642, 'n_tokens_neox': 605, 'n_words': 355}