Aller au contenu principal

Guide développeur

Ce guide aide les développeurs à s'intégrer avec Stockaj — que vous construisiez une application kiosque personnalisée, synchronisiez des données avec un système externe ou automatisiez des workflows.

Options d'intégration​

Stockaj offre plusieurs moyens d'intégration :

MéthodeIdéal pourPrérequis
API RESTOpérations CRUD complètes, synchronisation de donnéesToken API (forfait Starter+)
WebhooksNotifications d'événements en temps réelForfait Professionnel+
Scan QR CodeApplications kiosque/scannerCapacité kiosk token
Import CSV/ExcelMigration de données en masseAccès à l'interface web

Démarrage rapide​

1. Obtenir un token API​

Créez un token dans Paramètres → Tokens API avec les capacités nécessaires à votre intégration.

2. Faire votre première requête​

curl -X GET "https://app.stockaj.com/api/v2/items" \
  -H "Authorization: Bearer VOTRE_TOKEN" \
  -H "Accept: application/json"

3. Explorer l'API​

Parcourez la Référence API complète ou utilisez la documentation interactive à https://app.stockaj.com/docs/v2.

SDKs & Bibliothèques​

Stockaj ne fournit pas actuellement de SDKs officiels, mais l'API suit les conventions REST et fonctionne avec n'importe quel client HTTP :

  • JavaScript/Node.js — fetch, axios
  • Python — requests, httpx
  • PHP — Guzzle, Laravel Http
  • Ruby — httparty, faraday

Vue d'ensemble de l'architecture​

┌─────────────────────────────────────────────┐
│                 Votre App                    │
├──────────┬──────────────┬───────────────────┤
│  API REST │   Webhooks   │   Scan QR          │
│  (pull)   │   (push)     │   (scan→recherche) │
└──────┬───┴──────┬───────┴────────┬──────────┘
       │          │                │
       ▼          ▼                ▼
┌─────────────────────────────────────────────┐
│              Plateforme Stockaj              │
├─────────────────────────────────────────────┤
│ Articles │ Locations │ Locataires │ Alertes │ │
└─────────────────────────────────────────────┘

Patterns d'intégration courants​

Synchronisation d'inventaire​

Gardez un système externe synchronisé avec Stockaj :

  1. Synchronisation initiale — Utilisez l'API Articles pour récupérer tous les articles
  2. Synchronisation continue — Configurez des webhooks pour item.created, item.updated, item.deleted
  3. Résolution de conflits — Utilisez external_id pour le mapping entre systèmes

Application kiosque​

Construisez une station de check-in/check-out :

  1. Créez un token avec la capacité kiosk:scan
  2. Utilisez l'endpoint Kiosk Scan pour identifier les codes scannés
  3. Affichez les informations article/location
  4. Utilisez l'API Locations pour mettre à jour le statut

Tableau de bord analytique​

Construisez des analyses personnalisées :

  1. Récupérez périodiquement les locations avec des filtres de statut
  2. Agrégez l'historique de location des articles
  3. Utilisez les données des locataires pour l'analyse client

Limites de débit & Bonnes pratiques​

  • Mettez en cache les réponses quand possible pour réduire les appels API
  • Utilisez les webhooks au lieu du polling pour les mises à jour en temps réel
  • Paginez au lieu de tout demander en une seule fois pour les grands ensembles de données
  • Utilisez per_page pour contrôler la taille des réponses
  • Gérez les limites de débit en respectant les en-têtes Retry-After
  • Stockez external_id sur les articles et locataires pour le mapping inter-systèmes