Download the PHP package automile/automile-php without Composer

On this page you can find all versions of the php package automile/automile-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of automile/automile-php

Informations about the package automile-php

Automile

Official Automile REST API for PHP

Automile offers a simple, smart, cutting-edge telematics solution for businesses to track and manage their business vehicles. Automile is a next-gen IoT solution and the overall experience is unmatched. Business of all sizes love to use Automile to get fleet intelligence whether it is understanding driving behavior, recording vehicle defects and expenses, tracking vehicles real time or securing vehicles from un-authorized use.

Automile gives developers a simple way to build services and applications through its unique application program interface (API). Our simple REST based API support more than 400 core features empowering developers to access more data and enabling tighter integration to build apps for the connected ecosystem.

API information can be found at https://api.automile.com. If you need any help, we are here to help. Simply email us at [email protected] or chat with us.

The latest OpenAPI (fka Swagger) specification may be found at: https://api.automile.com/swagger/docs/v1

:yum:

This library allows you to quickly and easily use the Automile API via PHP.

This SDK is currently in beta. If you need help:

Prerequisites

Composer

To install the package via Composer, run the following command:

You also need to require Composer's autoload:

Manual Installation

If you prefer manual installation, you can download the latest release and include the autoload.php file in your code:

Sign Up

If you don't yet have an account, you can create one right here:

The code above creates an Automile account and provides you with the PHP code to configure the component:

Remember to save the code and/or the credentials for future usage.

Quickstart

First, let's initialize the client.

It's recommended to store the authentication token for futher use, otherwise the client would have to retrieve new token each time upon initialization.

The token must be stored either outside of the document root, or the directory must be protected via configuration files.

PHP should be allowed to read and write into the token storage directory for the client to function properly.

Note: Please make sure that the token storage path is not accessible via HTTP.

If the $isValid variable contains boolean true, everything works as a charm!

If something's not right, please report the issue to the Issue Tracker, and we'll get to it as soon as possible.

Note: Automile is currentley accepting username and password authentication for users belonging to private clients you are creating.

Methods

Vehicle Methods

All these methods are used to retrieve one or multiple vehicles and their current locations. You can also create, edit and delete vehicles.

Get all vehicles

Get details for a specific vehicle

Get status for all vehicles which will include the position of the actual vehicles

Check-in driver to vehicle

Check-out yourself

Trip Methods

Get all trips for the last days

Get overview for a specific trip

Note: This call contains overview details of a trip, if you want all datapoints you can instead use GetCompletedTripDetails() or GetCompletedTripDetailsAdvanced().

Get the start and stop latitude and longitude positions of the trip

Get all latituide and longitude locations during the trip

Get trip details for a trip

Get advanced trip details for a trip

Get all RPM values during a trip

Get all ambient temperature values during a trip

Get all engine coolant temperature values during a trip

Get all fuel values during a trip

Note: Only specific US makes and models are supporting fuel levels reporting

Edit trip tags and category

Set specific contact / driver for a trip

Contact Methods

All these methods are used to retrieve one or multiple contacts (drivers). Contact is considered a driver if they are checked-in into a vehicle.

Get all contacts/drivers

Get contact details by it's id

Get details around your self

Geofence Methods

Get all geofences

Get details for a specific geofence

Create a geofence and associating it with the first vehicle

To see the created geofence visit the web or mobile app

Edit a geofence

If you want to associate additional vehicles, check createVehicleGeofence() that adds an existing geofence to a vehicle

Delete a geofence

Notification Methods

All these methods are used to retrieve one or multiple notifications. You can also create, edit, mute, unmute and delete notifications. Notifications was earlier called Triggers.

With notifications you can also easily add webhooks, the destination for a notification could be:

Webhook format

The message data 1 and 2 will contains data relating to the actual used notification type. If you for example use a notificiation for trip start or trip end the messageData1 will contain the actual trip id.

Get all notifications (earlier called triggers)

Get details for a specific notification (earlier called triggers)

Create a notification

Why using a different identifier for notifications ? The reasons is that there are two objects, the vehicle contains all properties for a vehicle while a device (earlier called IMEIConfig) is connected to the vehicle. If you move the device to another vehicle the notifications are still valid.

Edit a notification

Mute a notification

Unmute a notification

Delete a notification

Notification Message Methods

This is used to get historic messages that have been sent to the destination configured.

Get all notifications messages

Get all notifications messages for a specific notification

Place Methods

With places you can track visits (stops) to locations and carry out certain automation rules. A place is a position (latitude and longitude) and a radius (given in metric meters).

Get all places

Get details for a specific place

Create a place for automation and associate it with the first vehicle

Edit a place

Delete a place

Device Methods

Devices are smartphones or/and Automile's smart boxes. Every box is attached to a vehicle. Notifications are attached to devices while places and geofences are attached to vehicles.

Get all devices

Get details for a specific device

Register a device and associate it to a vehicle

Edit a device

What do I use this for ? This method is used to move a device to another vehicle. Automile still apply automatic creation of vehicles and moving devices when they are moved to new vehicles. But in a cases you may want to move the device manually to another vehicle.

Delete a device

Fleet Methods

Fleets are used to divide vehicles into groups that can apply different security priviligies.

Get all fleets

Get details for a specific fleet

Create a fleet and associate it with me (in this case)

Edit a fleet

Delete a fleet

Attach Geofence Methods

A geofence can have one or many included vehicles which are called relationships. These methods allows you to list, get, create, edit and delete these relationships.

Get all vehicle geofences - relationships between a vehicle and a geofence

Get all relationships to vehicles for a specific geofence

Create a relationship between a vehicle and a geofence

Edit a vehicle geofence relationship

Delete a vehicle geofence relationship

Attach Places Methods

A place can have one or many included vehicles which are called relationships. These methods allows you to list, get, create, edit and delete these relationships. A vehicle that has a relationship to a place also have it's own radius and automation settings.

Get all vehicle places - relationships between a vehicle and a place

Get all relationships to vehicles for a specific place

Create a relationship between a vehicle and a geofence

Edit a vehicle place relationship

Delete a vehicle place relationship

Attach Driver Methods

A fleet can have one or multiple drivers (contacts) and one or multiple vehicles.

Get all drivers - relationships between all fleets and all drivers

Get specific driver relationships

Get all drivers for specific fleet - relationships between specific fleet and all drivers

Create a relationship between a driver and a fleet

Edit a driver and fleet relationship

Delete a driver fleet relationship

Device Events Methods

Device events are a number of events like connect, disconnect, mileage indicator lamp (MIL on/off), diagnostic trouble codes (DTC).

Get all device events

Getting details about a status event (connected or disconnected)

Getting details about a mileage indicator lamp (MIL) event (on or off)

Getting details about a diagnostic trouble code (DTC) event

Publish Subscribe Methods

Note: Currentley in alpha.

Publish subscribe mimics a message queuing system that allows you to create subscribers that whenever a message is published will repost the message to your endpoint. The publish subscribe framework is more resilient compared to simpler web hooks (that are available as part of our notifications) and allows for anonymous, basic, bearer and Salesforce specific authentication. It also allows for configurable retries and also extends to cover modification and creation of certain objects.

Publish subscribe guranteee that messages received have been fully processed in Automile's microservice architecture which means you can assume all properties have been set and calculated.

All published messages contains two common properties called PublishMessageType and PublishMessageDateTimeUtc.

PublishMessageType will contain information what kind of message you are receiving:

PublishMessageDateTimeUtc is the date and time (UTC) when the message was published.

Get all publish subscribe records

Get details about a specific publish subscribe record

Create a new subscription with anonymous authentication (several overloads available)

Edit a subscription (pointing to an endpoint requiring basic authentication)

Delete a subscription (will also delete queued messages)

Format for Trip End message

Format for Trip Start message

Format for Vehicle modified and created

For modified PublishMessageType will be 2.

All versions of automile-php with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
ext-curl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package automile/automile-php contains the following files

Loading the files please wait ....