Développeurs
L'API RAYVO
Reliez une boutique en ligne (Shopify, WooCommerce, YouCan…) ou un logiciel de caisse à Rayvo. À chaque commande payée, le client gagne ses points sur la même carte qu'en boutique, et son téléphone se met à jour tout seul.
DÉMARRER
- Le titulaire du commerce ouvre son espace Rayvo, Réglages → API, et crée une clé. Elle n'est affichée qu'une seule fois.
- Le développeur la range dans les variables secrètes de son serveur (
$RAYVO_API_KEY). - Chaque appel envoie la clé en en-tête, en HTTPS, vers
https://rayvo.dz/api/v1.
Les clients sont désignés par leur code client (C-XXXXXX), affiché sur leur carte Rayvo. L'API ne reçoit et ne renvoie aucune donnée personnelle : ni nom, ni email, ni téléphone.
AUTHENTIFICATION & SÉCURITÉ
Authorization: Bearer ray_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX- Serveur uniquement : Jamais dans le code d'une page web, d'un thème ou d'une appli mobile (CORS bloqué).
- Empreinte seule stockée : Clé perdue ou exposée ? Révoquez-la en un clic depuis votre tableau de bord.
- Limitation : 120 appels par minute et par clé. Au-delà : réponse 429 avec en-tête
Retry-After.
GET
/api/v1/clients/{code_client}Lire le solde d'un client
curl https://rayvo.dz/api/v1/clients/C-7K4M2P \ -H "Authorization: Bearer $RAYVO_API_KEY"
{
"code_client": "C-7K4M2P",
"unite": "points",
"solde": 85,
"recompenses_accessibles": [{ "titre": "Café offert", "cout": 50 }],
"prochaine_recompense": { "titre": "Brunch offert", "cout": 100, "manquant": 15 }
}POST
/api/v1/achatsCréditer un achat
curl -X POST https://rayvo.dz/api/v1/achats \
-H "Authorization: Bearer $RAYVO_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "code_client": "C-7K4M2P", "montant": 2400, "reference": "CMD-1042" }'{
"statut": "credite",
"code_client": "C-7K4M2P",
"reference": "CMD-1042",
"unite": "points",
"gagne": 24,
"solde": 109
}Idempotence garantie : Envoyée deux fois avec la même reference, la commande ne crédite qu'une seule fois (statut deja_enregistre).
POST
/api/v1/achats/annulationAnnuler un achat remboursé
curl -X POST https://rayvo.dz/api/v1/achats/annulation \
-H "Authorization: Bearer $RAYVO_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "reference": "CMD-1042" }'{ "statut": "annule", "reference": "CMD-1042", "unite": "points", "retire": 24, "solde": 85 }Une question, une intégration à faire ensemble ?
Écrivez-nous à contact@rayvo.dz