Aller au contenu principal

Utilisation et endpoints

Utilisation de l'API​

L'url de base de l'API est:

https://web.beeperf.com/api

Toutes les requêtes doivent être faites avec le header x-api-key qui contient la valeur de votre clé API. Cette clé doit avoir été générée au préalable. Pour que les requêtes aboutissent, l'utilisateur doit avoir un abonnement premium actif.

headers:
  "x-api-key": {votre_clé_api}
attention

Un abonnement premium est nécessaire pour utiliser l'API et chaque clé est limitée à 30 requêtes par minute.

Endpoints​

Récupérer la traçabilité d'un pot à partir de son numéro de lot​

GET /tracabilite/numero-lot/{numero_de_lot}

Format de la réponse :

{
  "dateConditionnement": "2024-07-04",
  "datesExtractions": ["2024-07-02", "2024-07-03"],
  "nbRuchesRecoltees": 12,
  "ruchers": [
    {
      "nom": "Rucher 1",
      "environnement": "Marais",
      "nomPublicZone": "Marais poitevin"
    },
    {
      "nom": "Rucher 2",
      "environnement": "Ville",
      "nomPublicZone": "Toits de l'Opéra Paris"
    }
  ]
}

Récupérer l'ensemble des numéros de lots​

GET /tracabilite/numeros-lots?per_page=25&page=2
attention

La pagination est forcée pour ne pas saturer la base de données. Si per_page est absent, sa valeur par défaut sera 10. Si page est absent, sa valeur par défaut sera 1.

Format de la réponse :

{
  "current_page": 1,
  "per_page": 3,
  "last_page": 4,
  "total": 12,
  "data": [
    "ACA-20250112"
    "TRE-20250215"
    "FOR-20240511"
  ]
}