Api: Endpoints

Endpoints

This section assumes you have completed an authenticated request and hold a valid token to make data requests. For more info on how to authenticate before you make API requests, visit the authentication page.

Version

Current version of the API is 1.0

Prefix for all endpoints:

https://apptrack.io/api/v1

Paths

These are all the endpoints available, sorted below based on their leading path:

App

All endpoints are under the /app namespace.

Models

With application-level OAuth2, the app is the connected entity - you get its details by simply calling:

/app

To get the details of any (other) app, append its common id:

/app/:id

Collections

As an extension of the app namespace you can request app-related collections.

To list the logs of an app

/app/:id/logs

To list the stores of an app

/app/:id/stores

Apps

A collection endpoint for listing all available apps.

/apps

The scope of the apps is defined differently based on the type of token used:

• With a CLI token it is the full list of apps of the user that matches the username/password in the .apptrack config
• With a user-auth token it is the apps of the logged in user

This endpoint is not supported for an application-level token.

Store

A very limited dataset is released to describe stores, when you already know its common id. This is mostly used to find out the store type.

/store/:id

Stores

A collection endpoint for listing all available stores.

/stores

The scope of the stores is defined differently based on the type of token used:

• With an application-level token it is the stores supported by the app
• With a CLI token it is the full list of stores of the user that matches the username/password in the .apptrack config
• With a user-auth token it is the stores of the logged in user

Log

All endpoints are under the /log namespace.

Model

To get the details of a single log simply append its common id:

/log/:id

Note that only the owner of the app has access to this information.

Logs

A collection endpoint for listing all available logs.

/logs

The scope of the logs is defined differently based on the type of token used:

• With an application-level token it is the logs of the app
• With a CLI token it is the full list of logs of the user that matches the username/password in the .apptrack config
• With a user-auth token it is the logs of the logged in user

User

All endpoints are under the /user namespace.

Model

To get the details of the currently logged in user simply use:

/user
```
The ```user``` is defined differently based on the type of token used. 
* With an application-level token it is the owner of the app
* With a CLI token it is the user that matches the username/password in the ```.apptrack``` config
* With a user-auth token it is the logged in user

To get the details of any (other) user, simply append its _common_ id:
```
/user/:id
```

#### Collections
As an extension of the user namespace you can request user related collections. 

To request a user's apps:
```
/user/:id/apps
```
To request a user's stores:
```
/user/:id/stores
```
Where ```id`` is the _common_ id of the user. 


### Disabled endpoints

The following endpoints are intentionally not implemented, as their application doesn't justify the security risk. 
```
/user/:id/logs
/users
```