LeLien API

Messenger application for shipping
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

LOG

RUN

USER

LOG

Up
get /log/list
log API activity (logListGet)
All queries to API

Query parameters

token (required)
Query Parameter — User ID key.

Return type

array[logs]

Example data

Content-Type: application/json
[ {
  "date" : "date",
  "module" : "module",
  "information" : "information",
  "status" : "status"
}, {
  "date" : "date",
  "module" : "module",
  "information" : "information",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

default

Error error

RUN

Up
post /run/calculate
Calculate the price (runCalculatePost)
This function return the price of shipping

Query parameters

token (required)
Query Parameter — User ID key
formatted_address_pick (required)
Query Parameter — Picking Address with google geocoding format: int
formatted_address_delivery (required)
Query Parameter — Delivery Address with google geocoding
distance (optional)
Query Parameter — Distance between two addresses
modeTransport (optional)
Query Parameter — Type of shipping.
duration (optional)
Query Parameter — Timing
date_start (optional)
Query Parameter — Date to begin the shipping.
datetime_start (optional)
Query Parameter — Time to begin the shipping.

Return type

array[price]

Example data

Content-Type: application/json
[ {
  "tarif" : 0.80082819046101150206595775671303272247314453125,
  "delai" : 6.02745618307040320615897144307382404804229736328125,
  "price" : 1.46581298050294517310021547018550336360931396484375,
  "status" : true
}, {
  "tarif" : 0.80082819046101150206595775671303272247314453125,
  "delai" : 6.02745618307040320615897144307382404804229736328125,
  "price" : 1.46581298050294517310021547018550336360931396484375,
  "status" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

default

Error Error_calcule

Up
post /run/create
Create a new run (runCreatePost)
create a new request for a shipping.

Query parameters

token (required)
Query Parameter — User ID key
formatted_address_pick (required)
Query Parameter — Picking Address with google geocoding.
picking_longitude (optional)
Query Parameter — Picking longitude.
picking_latitude (optional)
Query Parameter — Picking latitude.
formatted_address_delivery (required)
Query Parameter — Delivery Address with google geocoding.
delivery_longitude (optional)
Query Parameter — Delivery longitude.
delivery_latitude (optional)
Query Parameter — Delivery latitude.
distance (optional)
Query Parameter — Distance between picking and delivery addresses.
date_start (optional)
Query Parameter — Date to picking.
datetime_start (optional)
Query Parameter — Time to picking.
comment (required)
Query Parameter — information for the messenger

Return type

array[status]

Example data

Content-Type: application/json
[ {
  "status" : true
}, {
  "status" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

default

Error error

Up
get /run/tracking
track the shipping (runTrackingGet)
Show the status of your shipping and the date of delivery

Query parameters

tracking (required)
Query Parameter — Shipping ID.

Return type

array[trackers]

Example data

Content-Type: application/json
[ {
  "delivery_address" : "delivery_address",
  "date_start" : "date_start",
  "date_end" : "date_end",
  "picking_address" : "picking_address",
  "token" : "token",
  "status" : "status"
}, {
  "delivery_address" : "delivery_address",
  "date_start" : "date_start",
  "date_end" : "date_end",
  "picking_address" : "picking_address",
  "token" : "token",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

default

Error error

USER

Up
get /user/info
user information (userInfoGet)
Receive all informations of user.

Query parameters

token (required)
Query Parameter — User Key.
id (required)
Query Parameter — User ID.

Return type

array[info]

Example data

Content-Type: application/json
[ {
  "firstname" : "firstname",
  "phone" : "phone",
  "payement_choice" : "payement_choice",
  "stripe_token" : "stripe_token",
  "adresse" : "adresse",
  "company" : "company",
  "email" : "email",
  "status" : true,
  "token" : 0.80082819046101150206595775671303272247314453125,
  "lastname" : "lastname"
}, {
  "firstname" : "firstname",
  "phone" : "phone",
  "payement_choice" : "payement_choice",
  "stripe_token" : "stripe_token",
  "adresse" : "adresse",
  "company" : "company",
  "email" : "email",
  "status" : true,
  "token" : 0.80082819046101150206595775671303272247314453125,
  "lastname" : "lastname"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success.

default

Error. error

Models

[ Jump to Methods ]

Table of Contents

  1. Error_calcule -
  2. error -
  3. info -
  4. logs -
  5. price -
  6. status -
  7. trackers -

Error_calcule - Up

message (optional)
status (optional)

error - Up

status (optional)

info - Up

status (optional)
Boolean Réponse.
token (optional)
BigDecimal Clé de l'utilisateur.
email (optional)
String Email de l'utilisateur.
firstname (optional)
String prenom de l'utilisateur.
lastname (optional)
String nom de l'utilisateur.
adresse (optional)
String adresse de l'utilisateur.
phone (optional)
String téléphone de l'utilisateur.
payement_choice (optional)
String Moyen de paiement de l'utilisateur.
stripe_token (optional)
String token utilise pour les paiement par carte avec l'outil Stripe.
company (optional)
String Nom de la sociète de l'utilisateur.

logs - Up

date (optional)
String YYYY-MM-DD H:i:s.
module (optional)
String function API.
information (optional)
String comment.
status (optional)
String Status of shipping.

price - Up

status (optional)
Boolean Réponse pour déterminer la création.
tarif (optional)
BigDecimal Tarif de la course.
delai (optional)
BigDecimal Delai de la course.
price (optional)
BigDecimal Prix de la course T.T.C.

status - Up

status (optional)
Boolean Réponse pour déterminer la création.

trackers - Up

token (optional)
String tracking token.
picking_address (optional)
String Picking address.
delivery_address (optional)
String Delivery address.
date_start (optional)
String Start date of shipping.
date_end (optional)
String End date of shipping.
status (optional)
String Status of shipping.