Features
As you've noticed in the key creation process, there are multiple de/activatable features. Don't worry though, the options can all be tweaked after creation.
Most of these features are pretty self-explanatory (e.g: deactivating 'Allow job creation' will stop any attempt to create jobs with this key) — in this page, we'll explain the features which aren't entirely self-explanatory.
Security features
Rate limitation
By default, the maximum number of requests you can make an hour with any specific API key is 2500. However, if you want to enforce a smaller limit, you can do so.
Whitelisting IPs
Logis does not force you to define any whitelisted IPs — if none are defined, requests with an API key will be accepted from any IP address. If any IP is added to the whitelist, then requests coming from any IP not in the whitelist will be denied.
Using this feature significantly increases the security of your key.
Expiry date
An optional feature which will deactivate your key after the chosen date. Deactivated keys can be reactivated through the admin panel on Logis.
Activation
Without deleting the key, you can activate/deactivate the key at any time to stop or resume requests.
Job Manipulation
The main feature of our API service is to allow easy job transferring from your service to ours. In order to achieve this, we've implemented some helper features.
Auto-match existing clients
This feature is only in effect upon the creation of a Job without passing a client ID. If client ID avaibility is inconsistent, this feature is heavily recommended for simplifying data sync and minimizing redundancy. When active, upon job creation with no client ID passed, Logis will attempt to find a matching client with which to associate the Job. To do so, it requires one of:
- Email address.
- Phone number.
One of these two variables MUST be passed alongside the Job information for match. That being said, both can be passed for more precise checking, and these optional variables can also be passed to get added to the check:
- First name.
- Last name.
Once a valid client of yours has been matched, Logis will auto-fill the missing ID and pass it back to you in the response should you wish to save it for further requests.
Auto-create clients
If you wish to fully automate data transferring, this feature is a must-have. In the case that no client has been successfully associated with the Job creation request, if this feature is active, Logis will automatically create a new client.
For client creation, the following variables are minimally required:
- Email OR Phone number
- First name.
- Last name.
- A valid address, entailing:
- Optionally, an appartement number/code.
- Building number.
- Street name.
- City.
- Postal Code.
- Optionally, notes.
More optional entries can be passed, you can view the full client table here.
Learn more about API Job creation
Understand the expected passed data, response structure and more.
Tracking features
Logis already provides a customizable public tracking page, but some might prefer to offer basic tracking services on their own app/website, for branding, consistency and control purposes.
To allow for this, Logis offers API endpoints to fetch the state of a delivery, to get its code and to allow for review after delivery.
Fetch tracking information onto your service
Know where to send the request, what to include, and what to expect.