API REST v1

Documentation API

Automatisez vos verifications IMEI et deblocages. Facturation a l'usage sur votre portefeuille prepaye.

Authentification

Chaque requete porte votre cle API dans l'en-tete Authorization.

Authorization: Bearer VOTRE_CLE_API

Recuperez votre cle dans votre espace revendeur. Gardez-la secrete : elle donne acces a votre solde.

Base URL

https://votre-domaine.com/api/v1

Quotas (limitation de debit)

Chaque compte a une limite de requetes par minute (par defaut 60, ajustable). Chaque reponse renvoie :

X-RateLimit-Limit: 60 X-RateLimit-Remaining: 59 X-RateLimit-Reset: 1730880000

En cas de depassement : reponse 429 avec un en-tete Retry-After (secondes a attendre).

Endpoints

GET/api/v1/account

Solde, marge et quota de votre compte.

curl https://votre-domaine.com/api/v1/account \ -H "Authorization: Bearer VOTRE_CLE_API"
GET/api/v1/services

Catalogue des services actifs, avec votre prix revendeur.

curl https://votre-domaine.com/api/v1/services \ -H "Authorization: Bearer VOTRE_CLE_API"
POST/api/v1/orders

Place une commande. Corps JSON : service (slug) et imei. Le prix est debite de votre portefeuille ; remboursement automatique en cas d'echec fournisseur.

curl -X POST https://votre-domaine.com/api/v1/orders \ -H "Authorization: Bearer VOTRE_CLE_API" \ -H "Content-Type: application/json" \ -d '{"service":"blacklist-status","imei":"356938035643809"}'

Reponse :

{ "ok": true, "order": { "publicId": "FP-9EDLDK", "service": "Statut Blacklist (perdu / vole)", "imei": "356938035643809", "status": "DELIVERED", "priceCents": 39, "currency": "EUR", "result": "Statut Blacklist : PROPRE (non signale)", "errorMessage": null } }
GET/api/v1/orders/:publicId

Statut et resultat d'une de vos commandes.

curl https://votre-domaine.com/api/v1/orders/FP-9EDLDK \ -H "Authorization: Bearer VOTRE_CLE_API"

Codes d'erreur

CodeSignification
200Succes
400Requete invalide (IMEI ou champs manquants/incorrects)
401Cle API invalide ou absente
402Solde insuffisant — rechargez votre portefeuille
404Service ou commande introuvable
429Quota depasse — voir l'en-tete Retry-After

Besoin d'un quota plus eleve ou d'un service specifique ? Contactez l'equipe depuis votre espace revendeur.

Documentation API | FreePhone