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:
Récupérer le contenu de votre compte courrier ou colis. Vous pouvez affiner la recherche en utilisant les filtres.
Récupérer un item particulier en spécifiant son id
Récupérer les images d'un item en indiquant l'id de l'image et l'id de l'item
Mettre à jour le dossier (répertoire de classement) d'un item
Mettre à jour le drapeau d'un item
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
item_skustringréférence sku
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
<?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
<?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:
Récupérer toutes vos demandes d'expéditions. Vous pouvez affiner la recherche en utilisant les filtres.
Récupérer une expédition particulière en spécifiant son id
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_commentairestringCommentaire sur la demande
exp_dt_expeditiondate-usDate de changement du statut
exp_dt_envoidate-usDate de demande d'envoi
Filtres ( _eq, _lt, _gt, _like, etc )
start_pageintegerpar défaut 0
exp_statutstringstatut de la demande
exp_commentairestringcommentaire sur la demande
exp_dt_demandedate-usdate de création
exp_dt_expeditiondate-usdate de changement du statut
exp_dt_envoidate-usdate de demande d'envoi
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_itemsarrayLes ids des items contenus dans la demande
exp_statutstringStatut de la demande
exp_commentairestringCommentaire sur la demande
exp_dt_demandedate-usDate de création
exp_dt_expeditiondate-usDate de changement du statut
exp_dt_envoidate-usDate de demande d'envoi
exp_parts[] {arrayLes détails de l'expé réalisée
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
