Quick Start Guide

This page will walk you through the steps to generate a certificate, submit a request to an API endpoint, and receive your first response. By the end of this guide, you should have everything you need to begin your integration work.

Before beginning these steps, ensure that you have access to ARIES Admin in the chosen environment. If you do not have a username and password for ARIES, contact a member of the Autura staff for assistance.

Additionally, please locate your region code before continuing with this guide. Your region code can be found by navigating to your user in ARIES Admin and viewing the selection under “Default Region.“ For example, the San Francisco region code is SF-CA. This guide will use [regionCode] to indicate when you should fill in your region code.

In most cases, these steps should be performed in the staging environment before moving on to other environments. For this reason, the guide will assume you are operating in the staging environment.

Note: If you are using a tool like Postman, you can use this URL to import the OpenAPI spec: https://staging.autoreturn.net/api-web/openapi.json

Quick Start Instructions

For more in-depth information, see: Certificate Generation and Authentication to Aries API services

Autura’s APIs use password-protected OpenSSL pkcs12 certificates for authentication. These certificates can be generated using the ARIES Admin application. You can generate a file by logging into the Admin tool, selecting “Client Certificates” from the menu, and filling out the form.

Log in to ARIES Admin: https://staging.autoreturn.net/profile/company
Select “Menu” in the top right corner
Select “Client Certificates”
Enter the password into the first field
1. Note: This form does not require a duplicate password to be entered. Please double-check that you entered your password correctly before continuing
Enter the number of years for which this certificate will be valid
Select Download
Add the certificate to your environment.
1. For Postman, please follow the “Adding client certificates” instructions on this page: Adding client certificates
2. For cURL please see this example: curl -v --cert cert.p12 --cert-type p12 --pass passphrase
Submit a request to https://staging-api.autoreturn.net/api-web/api/towInfo/active/[regionCode]?practice=true
1. If you receive a response code in the 200 range, the test was successful
2. If you receive a response code in the 400 range, the certificate was not installed correctly

Congratulations! You just submitted your first request and received your first response. Your response should look like this:

[
    {
        "device": {
            "contactNumber": "14555321002",
            "deviceLocation": {
                "lat": 48.17583791187133,
                "lon": 16.337635243072835
            },
            "deviceType": "A",
            "id": 539
        },
        "vehicleId": 20302,
        "practice": false,
        "drNumber": "20240417A0001",
        "towStatus": "ON_SITE",
        "reasonCode": "187",
        "active": true,
        "requestedBy": "ig",
        "accountCode": "SFPDX",
        "equipmentCode": "Reg",
        "regionCode": "SF-CA",
        "origin": {
            "id": 109826,
            "locationType": "LAT_LNG",
            "addr1": "1501 Foxhollow Ln",
            "city": "Daly City",
            "state": "CA",
            "zip": "94014",
            "latLon": {
                "lat": 37.703626983661,
                "lon": -122.446337008125
            }
        },
        "driverNotes": "testii",
        "firstVehicle": {
            "noPlate": false,
            "noVin": false,
            "color": "BROWN",
            "vin": "NO VIN",
            "license": "NO PLATE",
            "model": "MOTORCYCLE",
            "make": "AGUSTA",
            "body": "2 DOOR",
            "licenseStateCode": "--",
            "id": 20302
        },
        "tto": {
            "towCompany": {
                "code": "ART",
                "name": "SF Test AutoReturn Company",
                "id": 265
            },
            "name": "Igor ART - SF 02",
            "id": 31135
        },
        "destination": {
            "id": 53,
            "locationType": "STANDARD",
            "addr1": "2650 Bayshore Blvd",
            "city": "Daly City",
            "state": "CA",
            "name": "SFPD CSI - BAYSHORE",
            "zip": "94014",
            "latLon": {
                "lat": 37.687924,
                "lon": -122.470208
            },
            "standardLocationId": 53
        },
        "id": 15919
    }
]

Next Steps

You can now begin to implement other APIs. You can view the API documentation here: API Documentation