Le client Okapi en ligne de commande

Ce client en ligne de commande facilite la consommation des Open APIs de La Poste, via la plateforme Okapi :

Pour consommer des APIs de La Poste, vous devez au préalable :

• Créer votre compte
• Créer une application et noter la clé d'app générée, à utiliser comme appKey dans le SDK
• Souscrire à une API du store

Installation

$ npm install laposte-okapi-cli -g

Utilisation

Obtenir le suivi du colis 1111111111111 :

$ oka get suivi/v1/1111111111111 -k 'mon_app_key'

Résultat :

{"code": "1111111111111","date": "25/06/2016","link": "http://www.chronopost.fr/expedier/inputLTNumbersNoJahia.do?lang=fr_FR&listeNumeros=1111111111111","message": "Echec de livraison, en attente d'instructions pour nouvelle livraison","status": "INCONNU","type": "Chronopost"}

Exemple de requête POST sur une API (myapi) avec un payload, le switch --tocurl retourne l'équivalent cURL (la requête n'est pas exécutée) :

$ oka post myapi/v1/resource -d 'firstName : "John"' -k 'mon_app_key' --tocurl

Commande cURL équivalente :

curl -ki -X GET "http://api.recette.okapi.laposte.io//myapi/v1/resource" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "X-Okapi-Key: mon_app_key" \
-d "firstName="John""

Détails

Toutes les options qui prennent un argument si elles sont appellées sans argument affiche leur valeur:

$ oka --env
[ ] production
[ ] preprod
[o] recette
[ ] development
[ ] vm
[ ] local

$ oka --baseUrl
https://api.laposte.fr

Pour de détails voir l'aide:

$ oka -h
Usage: oka [method] uri [options]
Options:
--env, -e get/set okapi env [chaine de caractère]
--baseurl, -u get/set okapi base URL [chaine de caractère]
--key, -k get/set okapi application key [chaine de caractère]
--save, -s save settings: application key, baseUrl, ignoreSSL [booléen]
--data, -d set request JSON payload, accept : direct data or file [chaine de caractère]
--query, -q set request query string params (format : key=value&...) [chaine de caractère]
--headers, -H extra request header [chaine de caractère]
--yaml, -Y display result in pretty YAML format [booléen]
--status, -t display status code [booléen]
--showheaders, -h display status code [booléen]
--version, -v show version [booléen]
--reset, -R reset settings to default [booléen]
--ignoressl, -I ignore SSL certificate error [booléen]
Exemples:
oka post niceapi/v1/niceresource -d 'foo:"bar"'
for more information, contact developer@laposte.io