API

REST API

Vous pouvez utiliser l'API de Little Bock pour créer des appels afin d'obtenir les données dont vous avez besoin pour intégrer Little Bock à votre système.

Avertissement

L'API n'étant pas encore finalisée, des changements peuvent être faits et la rendre non compatible avec votre implémentation.

Authentification

Pour vous authentifier, il vous faudra passer la clé API de votre compte Little Bock dans le header de chaque requête via la variable X-AUTH-TOKEN.

L'API est accessible seulement en HTTPS pour des raisons de sécurité.

L'API est seulement disponible pour les comptes Premium.

Exemple

curl --request GET 'https://www.littlebock.fr/api/recipes' --header 'X-AUTH-TOKEN: 782e2cc1bb62168dff8cf633f7e24012523f6bc06175ab5e1fccce98d7bacbf43a54ff61c7d0f555d809bc1c2ad188e70b2c'

Générer une clé API

Il est possible de générer une seule clé API par compte utilisateur Little Bock.

Pour communiquer avec l'API, il vous faudra obligatoirement une clé API.

Pour générer une clé API, vous pouvez le faire via la page "Mon compte", onglet "API", bouton "Générer ma clé API" : Mon compte

Si vous pensez que votre clé API est compromise (un tiers non autorisé en à connaissance), vous pouvez la regénérer via le bouton "Regénérer".

Rate limit

Une limite est fixée à 150 requêtes par heure et par clé API. Cette valeur peut changer.

Chaque réponse de l'API contient les valeurs suivantes dans le header :

• X-RateLimit-Remaining : Nombre d'appels restant

• X-RateLimit-Retry-After : Date (timestamp) de remise à zéro de votre consommation

• Retry-After : Date (timestamp) de remise à zéro de votre consommation

• X-RateLimit-Limit : Nombre maximum d'appels à l'API par heure

Code HTTP d'erreur en cas de limite atteinte : 429 Too Many Requests

Contact

Si vous avez des questions relatives à l'API ou des difficultés pour l'utiliser, vous pouvez envoyer un message via ce formulaire : Formulaire de contact

Documentation

La documentation complète de l'API est disponible ici : Documentation API