Développeurs

API de vérification des licences

Cette API permet à un logiciel Entrelyo de vérifier que sa licence est valide, d'enregistrer son installation et de la libérer. Toutes les réponses sont signées en HMAC-SHA256 pour empêcher toute contrefaçon.

Principe

Le logiciel installé chez le client interroge cette API pour savoir s'il a le droit de fonctionner. Une seule question lui est réellement posée : cette clé est-elle valide, aujourd'hui, sur ce domaine ?

L'API répond par un statut explicite et une date d'échéance. Le logiciel adapte son comportement :

Statut renvoyéSignificationComportement attendu du logiciel
validLicence activeFonctionnement normal
gracePaiement en attente, délai de tolérance en coursFonctionnement normal + bandeau d'avertissement
expiredÉchéance dépasséeBlocage, avec invitation à renouveler
suspendedSuspension administrative ou défaut de paiementBlocage
revokedLicence révoquée définitivementBlocage
activation_limitTrop d'installationsBlocage, avec lien vers l'espace client

Authentification

Chaque appel doit porter une clé d'API, créée depuis le back-office Entrelyo. Transmettez-la dans l'en-tête X-Api-Key :

POST https://entrelyo.fr/api/v1/license/validate
X-Api-Key: elk_live_xxxxxxxxxxxxxxxx
Content-Type: application/json

L'en-tête Authorization: Bearer <clé> est également accepté. Une clé peut être limitée à un logiciel, à une liste d'adresses IP et à un quota horaire.

Vérifier une licence

POST https://entrelyo.fr/api/v1/license/validate

ParamètreObligatoireDescription
license_keyouiClé au format ENTL-XXXX-XXXX-XXXX-XXXX
projectrecommandéIdentifiant du logiciel ; refuse la clé d'un autre produit
domainrecommandéDomaine de l'installation
fingerprintrecommandéEmpreinte stable de l'installation
app_versionnonVersion du logiciel, utile au support
php_versionnonVersion de PHP du serveur client

Réponse en cas de licence valide :

{
  "success": true,
  "data": {
    "status": "valid",
    "valid": true,
    "license_key": "ENTL-A1B2-C3D4-E5F6-G7H8",
    "project": { "slug": "mon-logiciel", "name": "Mon logiciel" },
    "expires_at": "2027-11-17T10:45:13+01:00",
    "days_remaining": 365,
    "perpetual": false,
    "activations": { "used": 1, "max": 3, "unlimited": false },
    "offline_days": 7,
    "recheck_after": "2026-11-18T10:45:13+01:00",
    "checked_at": "2026-11-17T10:45:13+01:00"
  },
  "signed_at": 1794908713,
  "signature": "3f7c…",
  "signature_algorithm": "HMAC-SHA256"
}

Activer une installation

POST https://entrelyo.fr/api/v1/license/activate

Enregistre explicitement une installation et consomme une activation. Appelée en général au moment de l'installation du logiciel. Les environnements de développement (localhost, .local, .test, adresses IP privées) ne consomment pas d'activation.

Libérer une installation

POST https://entrelyo.fr/api/v1/license/deactivate

Libère l'activation pour la réutiliser ailleurs. À appeler lors de la désinstallation ou d'un changement de serveur. Le client peut aussi le faire depuis son espace Entrelyo.

Dernière version publiée

GET https://entrelyo.fr/api/v1/projects/{identifiant}/latest

Renvoie le numéro de la dernière version, son empreinte SHA-256 et son journal des modifications. Si le paramètre license_key est fourni et que la licence est valide, la réponse contient également un lien de téléchargement temporaire.

Codes de réponse

HTTPCodeCause
200valid / graceLicence utilisable
401missing_api_key, invalid_api_keyClé d'API absente ou révoquée
403license_expired, license_suspended, license_revokedLicence non utilisable
403activation_limit_reachedQuota d'installations atteint
403domain_not_allowedDomaine différent de l'activation enregistrée
404license_not_foundClé inconnue
422missing_license_keyParamètre manquant
429rate_limit_exceededQuota horaire dépassé

Vérifier la signature

Chaque réponse contient signature et signed_at. La signature est le HMAC-SHA256 de la chaîne json(data) + "." + signed_at, calculé avec le secret de signature associé à votre clé d'API. Vérifiez-la systématiquement : elle protège contre un détournement DNS ou un fichier hosts modifié.

$payload  = json_encode($response['data'], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
$expected = hash_hmac('sha256', $payload . '.' . $response['signed_at'], $signingSecret);

if (!hash_equals($expected, $response['signature'])) {
    // Réponse non authentique : refuser
}

Tolérance hors-ligne

Un serveur injoignable ne doit jamais bloquer un client qui a payé. Le logiciel doit mettre en cache la dernière réponse valide et continuer de fonctionner pendant la durée indiquée par offline_days (7 jours par défaut). Passé ce délai sans vérification réussie, il est légitime de bloquer.

Client PHP prêt à l'emploi Une classe PHP complète — appel, cache, tolérance hors-ligne, vérification de signature — est fournie dans l'espace d'administration Entrelyo, avec la documentation détaillée. Demandez-la si vous intégrez un logiciel Entrelyo.