Les liens de téléchargement sont chrono-dégradables, et ne peuvent être obtenus que par le vendeur de la publication. Une étape intermédiaire gérée par le vendeur sert à recevoir la demande de téléchargement du client, et utilise l'API Téléchargement d'une publication pour instantanément rediriger l'utilisateur vers l'URL obtenue.
Étapes lors de la demande de téléchargement:
-
L'utilisateur clique sur le lien qui lui a été fourni pour télécharger son livre;
-
La page intermédiaire du site Web du vendeur reçoit la demande de téléchargement, construire l'URL de l'API Téléchargement d'une publication, et fait l'appel. Elle reçoit en retour une URL de téléchargement chronodégradable;
-
La page intermédiaire du site Web redirige l'utilisateur vers l'URL de téléchargement chronodégradable reçue;
-
Le téléchargement démarre.
Déclaration
Adresse :
/api/organisations/[:organisation_id]/customers/[:customer_id]/transactions/[:transaction_id]/publications/[:publication_id]/download_links/[:format]
Méthode : GET
Sécurité : HTTP/BASIC (Nom d'utilisateur et mot de passe)
Paramètres
|
Paramètre |
Obligatoire |
Description |
|---|---|---|
|
organisation_id |
Obligatoire |
Numéro d'organisation. Fourni lors de l'inscription. |
|
customer_id |
Obligatoire |
Le numéro du client. |
|
transaction_id |
Obligatoire |
Le numéro unique de la transaction / du panier d'achat. |
|
publication_id |
Obligatoire |
L'ISBN de la publication. |
|
format |
Obligatoire |
Le format de la publication vendue (pdf/epub/audio/proof). |
|
uname |
Optionnel |
Prénom et nom de l'utilisateur. Obligatoire si la vente est protégée par filigrane. La valeur de ce paramètre apparaîtra dans le texte du filigrane qui sera apposé sur le fichier. |
|
medium |
Optionnel |
Forme d'accès. Valeurs possibles: download (téléchargement du fichier), manifest (fichier manifeste), webreader (lecteur en ligne). Par défaut : download. |
|
passphrase |
Optionnel |
La phrase secrète est le mot de passe qui permettra à l'utilisateur d'ouvrir le contenu dans une application de lecture compatible. Ce même mot de passe doit être fourni par le libraire à l'utilisateur final. La valeur fournie dans ce paramètre, une représentation du mot de passe, doit subir les transformations suivantes, et ce, dans cet ordre:
|
|
passphrase_hint |
Optionnel |
Indice qui sera affiché à l'utilisateur comme aide-mémoire pour retrouver son mot de passe. La valeur du paramètre doit être encodée pour URL. |
|
help_url |
Optionnel |
URL d'une page d'aide spécifique à l'ouverture de contenus protégés par LCP, fournie par le libraire. L'utilisateur sera dirigé au besoin vers cette page. La valeur du paramètre doit être encodée pour URL. (255 caractères maximum) |
Réponses
|
Code HTTP |
|
|
|---|---|---|
|
200 |
OK |
URL chronodégradable du fichier à télécharger (expiration : 1 minute). Redirigez l'utilisateur vers cette URL. |
|
400 |
missing_transaction_id |
Le numéro de transaction était absent de la requête. |
|
401 |
access_denied |
Accès refusé à la ressource. |
|
404 |
not_found |
L'organisation n'a pu être trouvée. |