Step-by-step guide to taking Aito into use

1. Contact us to get your environment

We will get back to you with the details required for being able to use Aito:

  1. An environment endpoint: https://aitoai-ecom-demo.api.aito.ai
  2. A set of two API-keys:
    1. A read-only key (RO-key), which can be used to query the data, but not change it.
    2. A read-write key (RW-key), which can be used to change the schema and the data.
  3. The documentation to the enviroment

Please try out the environment with the [following command](https://aitoai-ecom-demo.api.aito.ai/version):

curl -X GET \
  --header 'x-api-key: READ-ONLY-API-KEY' \
  --header 'Content-Type: application/json' \
  https://aitoai-ecom-demo.api.aito.ai/version

{
  "name":"aitoai-core-v2",
  "version":"382",
  "gitRevision":"010b5125fbb5c9cd85542d14ccab320beefc73d5",
  "builtAt":"2018-09-12T10:25:50.352Z"
}

The query tests the connection to the environment and responds with details about the version of the environment. The details of the reponse will or course vary, as we upgrde the environments and bring new features and fixes.

2. Check out the documentation

Note that the documentation and the API format is still Work-in-Progress, so changes are to be expected!

We have two types of documentation. A longer human readable documentation, which contains examples and explanations on how to use the API to get the most out of the results. The second part is the technical documentation following the OpenAPI 3.0 format (formerly known as Swagger).

The human readable documentation can be found at the url: https://aitoai-ecom-demo.api.aito.ai/docs/v1/api/index.html

The OpenAPI-documentation for the API can be found with the environment. At the URL https://aitoai-ecom-demo.api.aito.ai/api-docs/v3/ you can browse the swagger documentation.

3. Upload some test data and try out some of the queries

The documentation contains examples of data and queries. We're aiming for making the learning curve gentle, but it's still best to start off with smaller example data to understand the functionality.

4. Contact us for support

We have a public slack channel where you can ask us questions. Shoot us an email to slack@aito.ai to get access. You can ask questions directly as well, but having a chat will save both time and effort compared to email ping-pong.