Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.oneclickdz.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Obtenir votre clé API

1

Créer un compte

Créez un compte gratuit sur app.oneclickdz.com
2

Générer des clés API

Accédez à Paramètres → Section API → Générer une clé APIVous recevrez deux clés :
  • Sandbox : Tests sans transactions réelles
  • Production : Transactions en direct
3

Sécuriser vos clés

Stockez les clés de manière sécurisée dans des variables d’environnement. Ne les exposez jamais dans du code côté client ni dans un système de contrôle de version.
Commencez toujours par le mode Sandbox pour tester votre intégration en toute sécurité.

​
Vérifier votre clé API

Testez votre clé API avec l’endpoint de validation : 
curl https://api.oneclickdz.com/v3/validate \
  -H "X-Access-Token: YOUR_API_KEY"
Réponse : 
{
  "success": true,
  "data": {
    "username": "+213665983439",
    "apiKey": {
      "type": "SANDBOX",
      "scope": "READ-WRITE",
      "isEnabled": true
    }
  }
}
Si vous voyez "success": true, votre clé API fonctionne correctement !

​
Étape 1 : Envoyer une recharge mobile

Envoyez une recharge de 500 DZD vers un numéro Djezzy : 
curl https://api.oneclickdz.com/v3/mobile/send \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: YOUR_API_KEY" \
  -d '{
    "plan_code": "PREPAID_DJEZZY",
    "MSSIDN": "0778037340",
    "amount": 500,
    "ref": "order-001"
  }'
Réponse : 
{
  "success": true,
  "data": {
    "topupId": "6901616fe9e88196b4eb64b0",
    "topupRef": "order-001"
  }
}

​
Étape 2 : Vérifier le statut de la recharge

Vérifiez le statut de votre recharge à l’aide de la référence : 
curl https://api.oneclickdz.com/v3/mobile/check-ref/order-001 \
  -H "X-Access-Token: YOUR_API_KEY"
Réponse : 
{
  "success": true,
  "data": {
    "status": "FULFILLED",
    "MSSIDN": "0778037340",
    "topup_amount": 500
  }
}
Flux de statut : PENDING (5s) → HANDLING (15s) → FULFILLED ✅

​
Étape 3 : Envoyer une recharge internet

Rechargez une ligne ADSL avec une carte de 1000 DZD : 
curl https://api.oneclickdz.com/v3/internet/send \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: YOUR_API_KEY" \
  -d '{
    "type": "ADSL",
    "number": "036362608",
    "value": 1000,
    "ref": "internet-001"
  }'
Réponse : 
{
  "success": true,
  "data": {
    "topupId": "6901616fe9e88196b4eb64b1",
    "topupRef": "internet-001"
  }
}
Vérifiez le statut de la recharge internet : 
curl https://api.oneclickdz.com/v3/internet/check-ref/internet-001 \
  -H "X-Access-Token: YOUR_API_KEY"
Réponse : 
{
  "success": true,
  "data": {
    "status": "FULFILLED",
    "card_code": "123456789012",
    "num_trans": "AT-2025-001"
  }
}

​
Étape 4 : Explorer les cartes cadeaux

Récupérez le catalogue de produits pour voir les cartes cadeaux disponibles : 
curl https://api.oneclickdz.com/v3/gift-cards/catalog \
  -H "X-Access-Token: YOUR_API_KEY"
Passez une commande de carte cadeau : 
curl https://api.oneclickdz.com/v3/gift-cards/placeOrder \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-Access-Token: YOUR_API_KEY" \
  -d '{
    "productId": "PRODUCT_ID",
    "typeId": "TYPE_ID",
    "quantity": 1
  }'
Réponse : 
{
  "success": true,
  "data": {
    "orderId": "6901616fe9e88196b4eb64c0"
  }
}
Récupérez les codes de cartes cadeaux en vérifiant le statut de la commande : 
curl https://api.oneclickdz.com/v3/gift-cards/checkOrder/6901616fe9e88196b4eb64c0 \
  -H "X-Access-Token: YOUR_API_KEY"
Réponse lorsque la commande est finalisée : 
{
  "success": true,
  "data": {
    "status": "FULFILLED",
    "cards": [
      {
        "value": "XXXX-XXXX-XXXX-XXXX",
        "serial": "123456789"
      }
    ]
  }
}
Les codes de cartes sont récupérés depuis le tableau cards lorsque le statut est FULFILLED

​
Tests en sandbox

En mode sandbox, testez ces scénarios spéciaux avec les recharges mobiles :
Numéro de téléphoneComportementObjectif
Tout numéro normal (ex. 0778037340)Succès : PENDING → HANDLING → FULFILLEDTester les transactions réussies
0600000001REFUNDED avec message d’erreurTester la gestion des remboursements
0600000002REFUNDED avec suggestions de forfaits alternatifsTester le désaccord de forfait
0600000003Statut UNKNOWN_ERRORTester la gestion des états incertains
Chaque guide de flux inclut des instructions de test en sandbox complètes avec des exemples.

​
Comprendre le format de réponse

Toutes les réponses de l’API suivent cette structure : 
{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "...",
    "pagination": { ... }
  },
  "requestId": "..."
}
En savoir plus sur le format de réponse →

​
Prochaines étapes

Guide recharge mobile

Flux d’intégration complet

Guide recharge internet

ADSL et 4G avec tests sandbox

Guide cartes cadeaux

Livraison de produits numériques

Gestion des erreurs

Gérer les erreurs correctement

Authentification

Modèles d’accès sécurisé à l’API

Bonnes pratiques

Sécurité prête pour la production
Besoin d’aide ? Consultez notre page Contact et support ou écrivez à [email protected]