HTTPS API REST

API DOCUMENTATION

Grâce à notre API, vous allez pouvoir vous connecter directement à notre base de données et récupérer les informations qui vous intéressent pour les intégrer dans votre propre système informatique.

Réception et articles

Avec les requêtes ci-dessous, vous pouvez: GET / v1 / {username} / {password} / items / ? {filter_name[ _eq / _gt / _gteq / _lt / _lteq / _like ]} = {value} & {filter_name...Récupérer le contenu de votre compte courrier ou colis. Vous pouvez affiner la recherche en utilisant les filtres.
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
item_dt_receptiondate-usDate de réception de l'item
Filtres ( _eq, _lt, _gt, _like, etc )
start_pageintegerpar défaut 0
item_codestringcode de l'item
item_dt_receptiondate-usdate de réception de l'item
item_dt_lecturestringdate de lecture de l'item
item_dt_expeditionstringdate d'expédition de l'item
item_expedition_idintegernuméro de l'expédition
item_dossierstringnom du dossier de l'item
item_drapeauchardrapeau de l'item
item_titrestringtitre de l'item
item_commentstringcommentaire de l'item
item_typechartype d'item
item_ocrstring
item_poidsintegermesure en Kg
item_longintegermesure en cm
item_largintegermesure en cm
item_hautintegermesure en cm
item_suivistringtracking en entrée
Réponses
item_idintegerNuméro de l'item
item_codestringCode de l'item
item_dt_receptiondate-usDate de réception de l'item
item_dt_lecturestringDate de lecture de l'item
item_dt_expeditionstringDate d'expédition de l'item
item_expedition_idintegerNuméro de l'expédition
item_dossierstringNom du dossier de l'item
item_titrestringTitre de l'item
item_commentstringCommentaire de l'item
item_typecharType d'item
   Valeurs possibles:
   "O" => Colis
   "N" => Lettre
   "P" => Palette
item_longintegerMesure en cm
item_largintegerMesure en cm
item_hautintegerMesure en cm
item_suivistringTracking en entrée
item_image_ids[] {array
   image_idstringId de l'image

}
Formulaire de test
usernamepassworditem_dt_reception 
...

Example:


<?php

//-- parameters used to filter the request    
$params_array = array("item_dossier_eq"=>"my_folder_name");
//-- Get a new instance of curl
$curl curl_init();
//-- curl options to prepare the GET request
curl_setopt_array($curl, array(
   
CURLOPT_RETURNTRANSFER => 1,
   
CURLOPT_URL => 'https://api.globeservices.fr/v1/my_username/my_password/items/?'http_build_query($params_array) ,
   
CURLOPT_FOLLOWLOCATION => true
));
// Send the request and store the result(json format) as string in $myResponse
$myResponse curl_exec($curl);
//-- free the curl resources
curl_close($curl);
if(
$myResponse){
    
$json_response json_decode($myResponse);
}
foreach(
$json_response as $item){
    
//-- will display the code number of each item
    
echo $item->item_code ."\n";
}
?>
GET / v1 / {username} / {password} / items / {item_id} Récupérer un item particulier en spécifiant son id
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
item_idintegerNuméro de l'item
Réponses
item_idintegerNuméro de l'item
item_codestringCode de l'item
item_dt_receptiondate-usDate de réception de l'item
item_dt_lecturestringDate de lecture de l'item
item_dt_expeditionstringDate d'expédition de l'item
item_expedition_idintegerNuméro de l'expédition
item_dossierstringNom du dossier de l'item
item_drapeaucharDrapeau de l'item
   Valeurs possibles:
   "R" => marquage rouge
   "B" => marquage bleu
   "V" => marquage vert
   "N" => Aucun marquage
item_titrestringTitre de l'item
item_commentstringCommentaire de l'item
item_typecharType d'item
   Valeurs possibles:
   "O" => Colis
   "N" => Lettre
   "P" => Palette
item_ocrstring
item_poidsintegerMesure en Kg
item_longintegerMesure en cm
item_largintegerMesure en cm
item_hautintegerMesure en cm
item_suivistringTracking en entrée
item_image_ids[] {array
   image_idstringId de l'image

}
Formulaire de test
usernamepassworditem_id 
...

Example:


<?php

//-- id of the item to get    
$item_id '101180367';
//-- Get a new instance of curl
$curl curl_init();
//-- Set the desired options for the curl request
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_URL => 'https://api.globeservices.fr/v1/my_usename/my_password/items/'$item_id,
CURLOPT_FOLLOWLOCATION => true
));
//-- Send the request and store the result(json format) as string in $myResponse
$myResponse curl_exec($curl);
// free the curl resources
curl_close($curl);
if(
$myResponse){
    
$json_response json_decode($myResponse);
    
//-- will display the code number of the item
    
echo $json_response[0]->item_code."\n";
}
?>
GET / v1 / {username} / {password} / items / {item_id} / image / {image_id}Récupérer les images d'un item en indiquant l'id de l'image et l'id de l'item
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
item_idintegerNuméro de l'item
image_idstringId de l'image
Réponses
image_idstringId de l'image
image_contentstringContenu de l\image encodé en base 64
image_content_typestringContent-type de l\image
Formulaire de test
usernamepassworditem_idimage_id 
...
PUT / v1 / {username} / {password} / items / {item_id} / dossier / {item_dossier}Mettre à jour le dossier (répertoire de classement) d'un item
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
item_idintegerNuméro de l'item
item_dossierstringNom du dossier de l'item
Réponses
Aucune information
Formulaire de test
usernamepassworditem_iditem_dossier 
...
PUT / v1 / {username} / {password} / items / {item_id} / drapeau / {item_drapeau}Mettre à jour le drapeau d'un item
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
item_idintegerNuméro de l'item
item_drapeaucharDrapeau de l'item
   Valeurs possibles:
   "R" => marquage rouge
   "B" => marquage bleu
   "V" => marquage vert
   "N" => Aucun marquage
Réponses
Aucune information
Formulaire de test
usernamepassworditem_iditem_drapeau 
...

Expeditions

Les requêtes liées aux expéditions vous permettent de:GET / v1 / {username} / {password} / expeditions / ? {filter_name[ _eq / _gt / _gteq / _lt / _lteq / _like ]} = {value} & {filter_name...Récupérer toutes vos demandes d'expéditions. Vous pouvez affiner la recherche en utilisant les filtres.
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
exp_statutstringStatut de la demande
exp_dt_expeditiondate-usDate de changement du statut
Filtres ( _eq, _lt, _gt, _like, etc )
start_pageintegerpar défaut 0
exp_statutstringstatut de la demande
exp_dt_demandedate-usdate de création
exp_dt_expeditiondate-usdate de changement du statut
Réponses
exp_idintegerNuméro de l'expédition
exp_adr_l1stringLigne 1 de l'adresse d'expédition
exp_adr_l2stringLigne 2 de l'adresse d'expédition
exp_adr_l3stringLigne 3 de l'adresse d'expédition
exp_adr_l4stringLigne 4 de l'adresse d'expédition
exp_adr_l5stringLigne 5 de l'adresse d'expédition
exp_adr_l6stringLigne 6 de l'adresse d'expédition
exp_adr_telstringNuméro de téléphone du destinataire de l'expédition
exp_itemsstringLes ids des items contenus dans la demande
exp_statutstringStatut de la demande
exp_dt_demandedate-usDate de création
exp_dt_expeditiondate-usDate de changement du statut
exp_parts[] {array
   part_idintegerNuméro de la partie
   part_typestringCode transporteur
   part_dimensionsintegerMesure en cm
   part_poidsintegerMesure en grammes
   part_nb_itemintegerNombre d'items contenu dans cette partie

}
part_no_suivistringTracking en entrée
Formulaire de test
usernamepasswordexp_statutexp_dt_expedition 
...
GET / v1 / {username} / {password} / expeditions / {exp_id} Récupérer une expédition particulière en spécifiant son id
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
exp_idintegerNuméro de l'expédition
Réponses
exp_idintegerNuméro de l'expédition
exp_adr_l1stringLigne 1 de l'adresse d'expédition
exp_adr_l2stringLigne 2 de l'adresse d'expédition
exp_adr_l3stringLigne 3 de l'adresse d'expédition
exp_adr_l4stringLigne 4 de l'adresse d'expédition
exp_adr_l5stringLigne 5 de l'adresse d'expédition
exp_adr_l6stringLigne 6 de l'adresse d'expédition
exp_adr_telstringNuméro de téléphone du destinataire de l'expédition
exp_itemsstringLes ids des items contenus dans la demande
exp_statutstringStatut de la demande
exp_dt_demandedate-usDate de création
exp_dt_expeditiondate-usDate de changement du statut
exp_parts[] {array
   part_idintegerNuméro de la partie
   part_typestringCode transporteur
   part_dimensionsintegerMesure en cm
   part_poidsintegerMesure en grammes
   part_nb_itemintegerNombre d'items contenu dans cette partie

}
part_no_suivistringTracking en entrée
Formulaire de test
usernamepasswordexp_id 
...

Documents

Les requêtes liées aux documents vous permettent de:GET / v1 / {username} / {password} / documents ? {filter_name[ _eq / _gt / _gteq / _lt / _lteq / _like ]} = {value} & {filter_name...Récupérer les données de documents téléversés tels que dates, statuts, types
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
Filtres ( _eq, _lt, _gt, _like, etc )
doc_typestringtype du document
doc_subtypestringsous type du document
doc_statutstringstatut du document
doc_dt_createdate-usdate de création du document
doc_dt_updatedate-usdate de modification du document
doc_dt_validitedate-usdate de validité du document
Réponses
doc_idintegerNuméro du document
doc_statutstringStatut du document
doc_dt_updatedate-usDate de modification du document
Formulaire de test
usernamepassword 
...
GET / v1 / {username} / {password} / documents / {doc_id} Récupérer une donnée d'un document particulier en indiquant son id
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
doc_idintegerNuméro du document
Réponses
doc_typestringType du document
doc_subtypestringSous type du document
doc_statutstringStatut du document
doc_dt_createdate-usDate de création du document
doc_dt_updatedate-usDate de modification du document
doc_dt_validitedate-usDate de validité du document
doc_paramsjsonParamètres du document
doc_storage_ids[] {array
   doc_storage_idintegerNom du document

}
Formulaire de test
usernamepassworddoc_id 
...
GET / v1 / {username} / {password} / documents / {doc_id} / storage / {doc_storage_id}Récupérer le fichier du document (pdf, jpg, etc)
Paramètres
usernamestringUsername to access your account
passwordstringPassword to access your account
doc_idintegerNuméro du document
doc_storage_idintegerNom du document
Réponses
doc_storage_idintegerNom du document
doc_storage_nomstringNom du document
doc_storage_contentstringContenu du document encodé en base 64
Formulaire de test
usernamepassworddoc_iddoc_storage_id 
...
Api réalisée par Globe Services Sarl 2017