API v1.0 · REST

Intégrez FarmLink
dans vos applications

Une API REST documentée et un SDK TypeScript officiel pour accéder au catalogue, aux vendeurs et aux catégories FarmLink.

Rate limit:100 req/min
Format:JSON / REST
Version:v1.0
Base URL:www.farmlinkmali.com

Endpoints disponibles

MéthodeEndpoint
GET
/api/v1/products
?search=, ?category=, ?limit=, ?cursor=
GET
/api/v1/vendors
GET
/api/v1/categories

Tous les endpoints nécessitent une clé API valide dans le header Authorization: Bearer <key>

SDK Officiel

JS
JavaScript / TypeScript
Disponible · v1.0.0
npm install @farmlink/sdk
PY
Python
Bientôt disponible
PHP
PHP
Bientôt disponible

Votre clé API

Connectez-vous à la Developer Console

Gérez vos clés API, vos applications et déployez le SDK depuis votre tableau de bord.

Exemples de code

SDK (@farmlink/sdk)
import { createFarmLink } from '@farmlink/sdk'

const fl = createFarmLink({ apiKey: 'YOUR_API_KEY' })

// Lister les produits
const { data: products } = await fl.products.list({
  category: 'Fruits',
  limit: 10,
})

// Lister les vendeurs
const { data: vendors } = await fl.vendors.list()

// Lister les catégories
const { data: categories } = await fl.categories.list()
response.json
{
  "status": 200,
  "data": [
    {
      "id": "prd_8f92a",
      "name": "Mangues Kent Fraîches",
      "price": 2500,
      "unit": "kg",
      "category": "Fruits",
      "stock": 500,
      "vendor": {
        "id": "ven_44b1c",
        "vendorProfile": {
          "farmName": "Ferme Coulibaly",
          "isVerified": true,
          "specialty": "Arboriculture fruitière"
        }
      }
    }
  ],
  "meta": { "hasMore": true, "nextCursor": "prd_..." }
}

Prêt à intégrer FarmLink ?

Créez un compte pour accéder à votre clé API, suivre votre consommation et intégrer le catalogue FarmLink dans vos applications.