Skip to main content

Introduction

You are able to use the AutoPi REST API with your browser, which will display our auto-generated documentation portal.

api_frontpage

Authentication​

If you want to test the endpoints, you can authenticate in the API documentation portal by setting the token to use when authenticating. In the picture above you can see there is a green 'Authorize' button which you need to press. This is where you'll be pasting your token.

It is possible to authenticate using two different tokens or sending the request manually using Postman (or similar).

1. API Tokens​

Authentication should be done with the API tokens. These tokens can be generated in the account page. The expire date is optional. The tokens can then be used in external systems to authenticate the requests. To use the token, you simply set the Authorization header to the following value, when sending HTTP requests to the API:

Authorization: APIToken YOUR_TOKEN

Creation of the API Token​

You can generate the new API Token in the AutoPi Cloud. Clicking on the in the Account tab in the side menu gets you to the Account Page.

On the Account Page you may see an API Tokens tab which gets you to the API Token creation part. Here you are able to create a new API Token by giving it a name and there is an option to set an expiration date for the token if you need and clicking the Create button.

account_page

2. JWT Token​

This token is the one used by the frontend when logging in. It expires relatively shortly and you need to enter you username and password to acquire the token.

Receiving the JWT Token​

You can get the JWT token in two different ways:

  • Capture the Token by Using the Browser Developer Tools - the easiest way is to capture the token by logging into the Cloud, with the developer tools open in your favourite browser, with the network tab open, and then skip to step 6 in the below step by step guide.

  • Manually Call the Auth Endpoint to get the Token. - you can follow the steps below to call the login endpoint manually.

    • Click the "auth" app to fold out the available endpoints.

    • Click the "/auth/login/".

    • Click the "try it out" button to the right.

    • Change the payload to look like this (remove the username field, and fill out the email and password fields, like so:

      {
          "email": "your_email",
          "password": "your_insanely_complex_password"
      }

    • Click the blue "execute" button.

    • Now you can copy the entire token.

    • Now click the green "Authorize" button in the top right of the page and paste the token in the field. Remember to write "Bearer" in front of the token - like so:

      Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.4pXwtyQKCwSrYfcj9O7MGVv5ustPbx0GmYY7jHZL8es

    • After clicking close, you should now be able to call the other authenticated endpoints.

3. Sending the Requests Manually Using Postman or Similar​

Alternatively, if you are unable to use the above portal, or if you'd rather use something like Postman or similar, you can still see the requests and parameters in the portal, but to call them manually, see the below steps.

Authenticating manually w/o interactive API documentation portal - you can do the above steps manually by following these steps:

  1. Authentication To obtain an authentication token, send a post request to https://api.autopi.io/auth/login/ with header

    Content-Type: application/json

    and body

    { "email": "your email address", "password": "your password" }

    In the response, you will find the token used to authenticate the below requests

  2. To request data from our API, the authorization header should be set.

    You will need to set the "Authorization" header on the requests. To set the header, use the below values.

    • If you're using a JWT token:
    Authorization: Bearer YOUR_TOKEN
    • If you're using an API token:
    Authorization: APIToken YOUR_TOKEN

tip

If you find something where you are unsure how to proceed, you can log in to my.autopi.io and use the developer tools of your favourite browser to see the requests and parameters sent by the application, and if you are still experiencing issues, you can send us an email to support@autopi.io

Telemetry data examples​

Accessing data from a device is done by calling the logbook endpoint.

Logbook Storage Read Parameters:

  • device_id: ID of the device you want to retrieve data from.
  • field: Name of the field you want to retrieve the value from.
  • field_type: type of the field
  • from_utc: ISO Datetime string
  • to_utc: ISO Datetime string
  • aggregation: Aggregation method (AVG, MIN, MAX, SUM)
  • interval: Data is aggregated based on the aggregation method specified, the interval specifies how many groups the data is grouped into. For example, getting data for a 10 hour period, with the interval set to 1h, you will get back 10 values, one value per hour.

1.Getting positions​

GET /logbook/storage/read/
?device_id=DEVICE_ID
&field=track.pos.loc
&field_type=geo_point
&from_utc=2020-01-01T00:00:00.000Z
&to_utc=2020-01-01T01:00:00.000Z

Example response:

[
    {
            "ts": "2020-07-09T10:11:53.811839Z",
            "location": {
                    "lat": 57.04699,
                    "lon": 9.93909
            }
    },
    {
            "ts": "2020-07-09T10:11:59.248421Z",
            "location": {
                    "lat": 57.04697,
                    "lon": 9.93808
            }
    }
]

2. Battery Voltage readings​

GET /logbook/storage/read/
?device_id=DEVICE_ID
&field=obd.bat.voltage
&field_type=float
&aggregation=avg
&from_utc=2020-01-01T00:00:00.000Z
&to_utc=2020-01-01T01:00:00.000Z
&interval=10m

Example response:

[
	{
    	    "max_ts": 1594289021415,
    	    "ts": "2020-07-09T10:03:37.566Z",
    	    "value": 13.5
	},
	{
    	    "max_ts": 1594289026525,
    	    "ts": "2020-07-09T10:13:45.378Z",
    	    "value": 13.600000381469727
	}
]

Let's keep in touch!​

Thank you for choosing AutoPi. We're excited to see what you will achieve with your AutoPi device!

Buy AutoPi device Check out our shop .

Learn more Check which device fits your requirements .

Contact our sales team You can build on top of AutoPi .

Get help from our support team Let us know about your technical questions.