laposte-okapi-sdk

![npm]()

Le SDK client Okapi pour JavaScript / nodejs / navigateurs

Ce SDK facilite la consommation des Open APIs de La Poste, via la plateforme Okapi :

!Developer La Poste

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 i laposte-okapi-sdk --save
`

Utilisation

`javascript
const okapiSdk = require('laposte-okapi-sdk');
const oka = okapiSdk({appKey: 'mySecretAppKey'});
oka.api('superapi')
.version(1)
.resource('contacts')
.get()
.spread((data, res) => {
console.log('data :', data);
console.log('status code :', res.statusCode);
})
.catch(function(err) {
console.error(err);
});
`

La méthode verbe déclenche la requête avec la l'équivalent HTTP de get, post, put, patch ou delete.

Tous les exemples suivants sont équivalents :

- chainage :

`javascript
oka.api('superapi').version(1).resource('contacts').get()
`

- la méthode verbe accepte une chaîne de caractère comme chemin de la ressource :

`javascript
oka.api('superapi').version(1).get('contacts')
`

- la méthode verbe considère le paramètre comme l'URL complète s'il est du type String et qu'aucune API n'a été renseignée au préalable :

`javascript
oka.get('superapi/v1/contacts')
`

- construction directe via un objet :

`javascript
oka.build({ api: 'superapi', version: 1, resource: 'contacts'}).get()
`

- encore plus direct via la méthode verbe :

`javascript
oka.get({ api: 'superapi', version: 1, resource: 'contacts'})
`

Utilisation dans un navigateur

$3

- Version adaptée à la production :

`html

`

- Version non minifiée pour les développements :

`html

`

$3

- Version adaptée à la production :

`html

`

- Version non minifiée pour les développements :

`html

`

Référence API

Les méthodes suivantes peuvent être chainées : elles retournent this (Object) pour permettre un chainage des appels.

$3

Définit le contexte d'URL de l'API à consommer.

Arguments : contexte d'URL de l'API (String)

$3

Définit la version de l'API à consommer.

Arguments : version (Integer|String)

$3

Définit l'URI de ressource de l'API à consommer.

Arguments : URI de la ressource (String)

$3

Définit une URI complète à utiliser (alternative à l'utilisation de .api et .version).

Arguments : uri (String) (ex : '/APIname/APIversion/resource')

$3

Définit le corps de la requête.

Arguments : corps (Object)

$3

Définit les paramètres de query string.

Arguments: query (Object)

$3

Défnit les paramètres de l'URI.

Arguments: params (Object)

$3

Définit un fichier à uploader.

Arguments: attachment (Object)

$3

Méthode utilitaire tout-en-un qui construit l'URI.

Arguments: opt (Object)

Exemple :

`{API name, API version, resource, [...]})`

Les méthodes suivantes ne sont pas chainées :

$3

Retourne l'URL complète de la requête.

Arguments: [opt] (Object)

Exemple :

`{API name, API version, resource, [...]}`

Retourne une URL complète (String)

$3

Ces méthodes sont identiques à leur équivalent HTTP, l'invocation de l'une de ces méthode déclenche l'appel de la requête au serveur.

Arguments: [opt] (Object)

Exemple :

`{API name, API version, resource, [...]}``

Retourne une promesse qui se réalise avec les arguments suivants :
- res : réponse (Object)
- body : corps de la réponse body (Object)