CargOffer - API-Rest
Cargoffer API Documentation
Welcome to the exciting world of Cargoffer!
We are delighted to introduce you to our API, an open door to a world of possibilities for your applications and business solutions.
Here at Cargoffer, we believe in collaboration and the power of shared innovation, which is why we have designed our API with you, our valuable users, in mind.
Index
1. Introduction
What does this mean for you?
Full and unrestricted access to all requests of our API!
Yes, you read that correctly, all registered users on our platform can enjoy this incredible advantage.
We want you to make the most of your experience with Cargoffer, which is why we offer you this tool for free, at no additional cost.
The most important functionalities that you can perform from the platform can also be done through API-Rest services if needed.
We follow standard communication protocols and secure communication for all your data, so you can trust the security of the processes. Similarly, we use open documentation protocols, which allows you to have examples of how to implement Cargoffer in your software, regardless of the framework or language you use.
If you have any questions, contact us and we will help you as much as we can.
2. Accessing the API
In this section, we will explain how to access our API and what steps you need to follow to start using it in your applications. We will cover aspects such as authentication and available resources.
2.1 - Authentication
Request authentication is done through a token generated within the platform. Through the web interface; within the sections:
'Settings' -> 'ApiKeys'
All requests will require the mandatory inclusion of this apiKey; if not provided, all requests to the server will be rejected. This apiKey will be used to identify you on the platform, to record your behavior in it, and for security checks. If you notice any strange or unusual behavior on the platform, we recommend that you delete the key and generate a new one. These apiKey keys will only be visible at the time of creation, so you should copy it to a secure location before closing the window.
Within this section, the apiKey will be created according to the use that will be given to it. For the case; we have 3 possible uses, and each of them will have access to a type (or section) of the requests:
- Admin -> You will have access to all requests and sections of the ApiRest
- Shipments -> You will have access only to requests related to shipments
- Planning (Drafts)
- Auction Creation
- Private Shipping Creation
- Check the status of your Shipments
- Validation and signing of service contract (Delivery)
- etc.
- Deliveries and Billing -> You will have access to review the status of deliveries, the export of information, and the billing (payment) of the services provided to you by the carriers.
- Invoice Download
- Review status (and ETA) of deliveries
- Communication (Chat) with the carrier
- Download of eCMR
- Export of Service Documentation
- Viewing (and download) of pick-up/delivery proof images
- etc.
3. Uses and Possibilities
The use of the ApiRest with Cargoffer is not limited; but it is monitored. It is also subject to reasonable use of the platform; as well as limited communication to a number of requests per minute per user.
ATTENTION: We say user; NOT apiKey. So in case a Company has an API-Rest usage above what is expected, or possible DDoS attacks are detected (or that could pose a danger to server stability) they will be directly deleted from the database; and a notification will be sent to the responsible person, communicating a warning or limitation in order to guarantee the proper functioning of the platform.
Reasonable use of the platform is understood as limited status inquiries to 10 per minute, and data creation/modification to 4 per minute. If users need to expand this service quota, they must communicate it in writing.
4. Glossary
Below we will discuss the terms used in the platform and what they will refer to, as well as what they will be used for within the Cargoffer platform.
4.1 Auction
We call Auctions (Shipments) all the shipment auctions; so here you will have the requests related to creating, listing, and editing the auctions for your Shipments.
These can be public in nature; and receive offers from carriers.
When creating these public auctions, the real cost of the journey and expenses derived from it will be taken into account; such as toll costs, wear and tear, oil changes, insurance, diets (if necessary, by schedule), etc. So you will receive an error regarding this if it is not compatible with Cargoffer's main red line; a fair price for everyone.
Keep this in mind when creating an auction; put the maximum price you are willing to pay, carriers will bid down for your service.
In the case of private shipments; it will be necessary for the account to be Multitennant and you have registered on the platform the necessary data for your internal management of trips: drivers, vehicles, and addresses (pick-up and delivery).
4.2 Delivery
We call Delivery to deliveries. These deliveries will be both public and private; and you will be able to receive the data of the status of each of them.
In the detail of each Delivery (delivery), you will have the information of the communication messages with the carrier, the contact data (telephone, email), and the documentation associated with the delivery.
So in this section, you will have the requests that have to do with this process; such as seeing the detail, listing, and filtering your delivery history, etc.
4.3 Address
To be able to create the Auctions, you have to have addresses; in this section, we help you with the necessary requests to manage the addresses.
The addresses are registered both in physical address and GPS positioning to avoid problems when managing the Shipments. Also; to be able to make the calculations regarding the expenses of the transport.
Keep in mind that we help you by naming the address; so that it is easier for you to recognize them in the selection when you create an Auction. As well as; a company name and a contact phone in case it is necessary for the carrier, or your internal management.
4.4 Vehicles - (MultiTennant)
If you have your own fleet of transport; this is the section you need to be able to manage all your vehicles.
If your account is Multitennant; you will have access to the management of the vehicles that can be selected for the creation of Private Auctions. So those that are compatible with the service will be selectable.
Also keep in mind; that we will ask you to have the documentation of each vehicle up to date, and we will send you recommendations on maintenance, renewals of technical documentation, and circulation permits (MOT).
In the registration and modification process (of the license plate) we will do a Brand/Model verification to check that the vehicle data is correct.
4.5 Drivers - (MultiTennant)
If you have your own fleet of transport; this is the section you need to be able to manage all your drivers.
If your account is Multitennant; you will have access to the management of the drivers who will be able to make the merchandise transports.
We will take into account the rest rights, and that the drivers are available for each trip. So be careful when trying to select them for Private Auctions; or you will receive a message warning about the incompatibility of the trips.
5. Usage Examples
Learn through practical examples. We will provide you with code examples to help you understand how to interact with our API and how to implement specific functionalities in your applications.
6. Support and Community
We want to help you with everything you need, and we can help you. So we put an email at your disposal for all the technical doubts you may have: info@cargoffer.com
We will try to respond to you as soon as possible; but it will depend on the number of pending requests we have.
Similarly; on the platform you have the section of 'Issues' for internal platform management.
Authentication
- API Key: PROJECT
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | PROJECT |