Documentation développeur DZBuild
DZBuild (dzbuild.com) est la plateforme e-commerce des marchands algériens : boutiques en ligne avec paiement à la livraison, livraison par transporteur dans les wilayas, pages de destination et messages WhatsApp de commande. Une application DZBuild est un service que vous hébergez sur vos propres serveurs. Le propriétaire d'une boutique l'installe, puis votre serveur lit et modifie les données de cette boutique via l'API REST. Aucune ligne de votre code ne tourne sur DZBuild.
Par exemple, une application d'export de catalogue permet au marchand de télécharger ses produits dans un fichier CSV. Le marchand installe l'application, votre serveur lit les produits de sa boutique avec les permissions accordées, puis votre application prépare l'export. Le starter cloudflare-catalog fournit cet exemple.
Choisir un point de départ
| Vous voulez | Commencez ici |
|---|---|
| Créer et tester votre première application | Choisissez un starter, puis suivez Premiers pas pour l'enregistrer et l'installer. |
| Travailler avec un agent de code | Connectez votre agent, puis suivez Développer avec l'IA. La connexion lui donne un accès en lecture seule à la documentation. |
| Trouver une opération de l'API ou ses permissions | Consultez la référence de l'API et les scopes. |
Ce que propose la plateforme
| Élément | Ce qu'il apporte à votre application |
|---|---|
| Applications | Vous enregistrez votre application dans la console développeur. Elle reçoit un client_id, un client secret et un secret de signature. |
| Parcours d'installation | Le propriétaire de la boutique approuve votre application sur un écran de consentement. Le parcours est OAuth 2.0 avec code d'autorisation et PKCE S256. |
| Jetons d'installation | Chaque boutique qui installe votre application reçoit son propre jeton bearer, limité aux scopes que le propriétaire a acceptés. |
| API REST | https://api.dzbuild.app/v1 couvre la boutique, les produits, les commandes, la livraison, les clients, les landing pages, les codes promo, les pixels, l'expédition, les statistiques et WhatsApp. |
| Webhooks | DZBuild envoie les événements de commande et app.uninstalled à votre adresse, signés avec X-DZ-Signature. |
| API WhatsApp | Votre application envoie aux acheteurs les modèles de commande approuvés de la plateforme. Chaque message est payé sur le solde WhatsApp de la boutique. |
| Lien d'ouverture | Le bouton Ouvrir du tableau de bord marchand mène à votre application avec un jeton signé dans dz_launch. |
| Console développeur | https://dzbuild.com/dashboard/developer sert à enregistrer vos applications, renouveler leurs secrets, les tester sur votre boutique et les envoyer en vérification. |
À qui s'adresse cette documentation
Ces pages s'adressent aux développeurs qui créent des outils que les marchands DZBuild installent depuis leur tableau de bord. Tout compte DZBuild rattaché à une boutique peut ouvrir la console développeur. Tant qu'une application est en brouillon ou en vérification, elle ne s'installe que sur les boutiques dont le compte développeur est propriétaire. Une fois approuvée par DZBuild, tout propriétaire de boutique peut l'installer, quel que soit son plan, sauf si vous fixez un plan minimum.
La documentation marchand se trouve sur dzbuild.com/docs. Elle présente le tableau de bord du point de vue du marchand.
DZShip : API d'expédition gratuite
DZShip est une API hébergée gratuite, distincte de l'API des applications, pour créer et suivre des colis auprès des transporteurs algériens. Elle ne demande ni inscription ni clé API DZShip : vous fournissez vos propres identifiants de transporteur à chaque requête. Son sandbox permet de tester des requêtes sans créer de vrais colis. L'accès à l'API est gratuit ; les frais de livraison du transporteur restent dus.
Consultez le dépôt DZShip et sa documentation API pour les champs des requêtes et les exemples. Les starters d'applications et les autres projets publics se trouvent sur DZBuild sur GitHub.
Pour continuer
- Premiers pas : enregistrez une application, installez-la sur votre boutique et faites votre premier appel à l'API.
- Concepts clés : applications, installations, boutiques, plans, mode test, limite par installation et jetons d'installation.
- OAuth : chaque paramètre d'autorisation et d'échange de jeton, et chaque code d'erreur.
- Scopes : ce que permet chaque scope.
- Webhooks : événements et vérification de la signature.
- API WhatsApp : envoi des modèles de commande.
- Limites de requêtes : quotas de requêtes et nouvelles tentatives.
- Référence de l'API : tous les endpoints
/v1et la description OpenAPI. - Règles de vérification et Sécurité : ce que DZBuild contrôle avant d'approuver une application.
- Journal des modifications : les changements datés de la plateforme.