Comment utiliser les API Headless OTP sur la boutique Shopify
Marché
La sécurité des comptes clients et des transactions est essentielle dans le monde en constante évolution du e-commerce. La mise en œuvre de la vérification par mot de passe à usage unique (OTP) est un moyen efficace d'améliorer la sécurité et de protéger les informations sensibles. Dans ce guide API, nous vous expliquerons comment activer la vérification par OTP sur votre boutique Shopify.
Shopify est une plateforme e-commerce populaire, reconnue pour son évolutivité et sa flexibilité, ce qui en fait un excellent choix pour les entreprises de toutes tailles. Vous pouvez renforcer la sécurité de vos comptes utilisateurs, de vos processus de paiement et bien plus encore en intégrant la vérification OTP à votre boutique Shopify.
Ce guide étape par étape donne des instructions sur la façon d'utiliser les API OTP sans tête sur votre boutique Shopify à l'aide de l'application de connexion OTP miniOrange.
Pré-requis : Application de connexion Shopify OTP
Pour utiliser les API OTP sans tête, vous devrez installer le Demande de connexion OTP miniOrange sur votre magasin.
Consultez les face , pour en savoir plus sur le fonctionnement de l'authentification unique dans Shopify.
Étapes de configuration
Guide étape par étape pour intégrer la vérification OTP sur votre boutique Shopify
Étape 1 : Créer un en-tête d'authentification
- Pour utiliser notre défi et valider les API Rest, vous devez d'abord définir les en-têtes d'autorisation nécessaires pour garantir que la demande est effectuée par un utilisateur valide.
- Les valeurs suivantes doivent être spécifiées dans l'en-tête de requête HTTP. Elles seront identiques pour les requêtes OTP et les appels de validation OTP.
| Attribut | Description |
| Clé client | Votre clé client. |
| Horodatage | Le temps en millisecondes pendant lequel la demande est effectuée. |
| Autorisation | Valeur de hachage Sha 512 composée de la clé client, de l'horodatage actuel et de la clé API. |
EXEMPLE DE CODE :
JAVA
/* JSON Object format for challenge API request */
{
/* You can get customer Key and customer Api
Key from
shopifysupport@xecurify.com
*/
String customerKey = "<YOUR_CUSTOMER_KEY>"; String apiKey =
"<YOUR_API_KEY>";
/* Current time in milliseconds since midnight, January 1, 1970 UTC.
*/
String currentTimeInMillis = String.valueOf(System.currentTimeMillis());
/* Creating the Hash using SHA-512 algorithm (Apache Shiro library)
*/
String stringToHash = customerKey + currentTimeInMillis + apiKey; String
hashValue = new Sha512Hash(stringToHash).toHex().toLowerCase(); HttpPost
postRequest = new HttpPost("");
/* Setting the Authorization Header values */
postRequest.setHeader("Customer-Key", customerKey);
postRequest.setHeader("Timestamp", currentTimeInMillis);
postRequest.setHeader("Authorization", hashValue) }
PHP
/* JSON Object format for challenge API request */
{
/* You can get customer Key and customer Api
Key from
shopifysupport@xecurify.com
*/
$customerKey = "<YOUR_CUSTOMER_KEY>"; $apiKey = "<YOUR_API_KEY>";
/* Current time in milliseconds since midnight, January 1, 1970 UTC.
*/
$currentTimeInMillis = round(microtime(true) * 1000);
/* Creating the Hash using SHA-512 algorithm */
$stringToHash = $customerKey . number_format ( $currentTimeInMillis, 0, '', ''
) . $apiKey; $hashValue = hash("sha512", $stringToHash);
/* Add $customerKeyHeader,$timestampHeader and $authorizationHeader in the
HTTP header */
$customerKeyHeader = "Customer-Key: " . $customerKey; $timestampHeader =
"Timestamp: " . number_format ( $currentTimeInMillis, 0, '', '' );
$authorizationHeader = "Authorization: " . $hashValue; }
Étape 2 : Génération OTP / API REST de défi
- Vous devez envoyer une requête HTTP GET à notre API REST de génération d'OTP/Challenge pour générer un OTP pour le numéro de téléphone/l'adresse e-mail. Notre API REST Challenge accepte les paramètres de requête suivants :
- Point de terminaison de génération d'OTP : https://store.xecurify.com/moas/rest/shopify/api/auth/headless/otprequest
Paramètres de demande :
| Attribut | Description |
| acheter | Votre domaine de boutique Shopify (myshopify) sur lequel l'application de connexion/inscription miniOrange OTP est installée. |
| à |
L'adresse e-mail ou le numéro de téléphone auquel vous souhaitez que nous envoyions l'OTP. Remarque : la valeur fournie ici doit être présente dans votre liste de clients Shopify |
| action | Écrivez le type d'action comme "connexion" or "registre" selon votre condition |
Vous pouvez vous référer à l'image pour mieux comprendre les actions.
Activez le bouton à bascule indiqué ci-dessous pour Autoriser la connexion par code OTP pour les nouveaux utilisateurs.
Réponse JSON
- Voici la réponse JSON générée par l'API Generate Rest.
/* JSON Response Object for Generation Request */
{ "responseType": "CHALLENGE", "phoneDelivery":{ "contact": null,
"sendStatus": null, "sendTime": null }, "customerID": "5745403199697",
"txId":"<UNIQUE_TRANSACTION_ID>", "emailDelivery": { "contact":
"<EMAIL_ADDRESS_OTP_WAS_SENT_TO>", "sendStatus": "SUCCESS", "sendTime":
"09-05-2023 05:22:37" }, "authType": "EMAIL",
"message": "The OTP has been sent to ixxxxxxxxxxxa@xxxxxxxx.com.
Please enter the OTP you received to Validate.",
"status": "SUCCESS" }
| Attribut | Description |
| txid | Il s'agit de l'ID de transaction de votre demande de génération. Vous devrez enregistrer cette valeur dans la session. Elle devra être envoyée à l'API de validation. |
| Type d'authentification | La méthode d'authentification. Dans ce cas, il s'agit de l'e-mail. |
| type de réponse | Ceci indique le type de réponse : Réponse à une demande de défi ou de validation. Valeurs valides : DÉFI |
| téléphoneLivraison | Statut de livraison par téléphone. Il est fourni en cas d'authentification via mobile. |
| contactez | Le numéro de téléphone OTP a été envoyé, c'est-à-dire mobile. |
| envoyerStatut | Statut d'envoi du contact ci-dessus. Valeurs valides : SUCCÈS, ÉCHEC, ERREUR |
| envoyerHeure | Horodatage indiquant l’heure d’envoi. |
| message | Un message supplémentaire indiquant l'état global de la demande. |
| statuts | État général de la demande de défi/validation. Valeurs valides : SUCCÈS, ÉCHEC, ERREUR |
Étape 3 : Validation OTP/Vérification de l'API REST Challenge
- Pour valider un OTP, vous devez envoyer une requête HTTP GET à notre API Rest Validate. Notre API Rest Validate accepte les paramètres de requête suivants :
- Notre API de validation est : https://store.xecurify.com/moas/rest/shopify/api/auth/headless/otpverify
Paramètres de demande :
| Attribut | Description |
| txid | L'ID de transaction pour lequel la requête a été générée. Il est envoyé comme paramètre de réponse dans l'API Generate. |
| acheter | Votre domaine de boutique Shopify (myshopify) sur lequel l'application de connexion/inscription miniOrange OTP est installée. |
| à | L'adresse e-mail ou le numéro de téléphone auquel vous souhaitez que nous envoyions OTP. |
| Bureau du Procureur | OTP reçu sur votre mobile/e-mail. |
Réponse JSON
- Voici la réponse JSON générée par l'API Validate Rest.
/* JSON Response Object for Validation Request */
{ txId: "<UNIQUE_TRANSACTION_ID>" responseType: "VALIDATE" status:
"SUCCESS" message: "Successfully Validated" }
| Attribut | Description |
| txid | Il s'agit de l'ID de transaction pour votre demande de génération. |
| type de réponse | Ceci indique le type de réponse : Réponse pour une requête de génération ou de validation. Valeurs valides : VALIDATE. |
| statuts | État général de la demande de génération/validation. Valeurs valides : SUCCÈS, ERREUR, ÉCHEC. |
| message | Un message supplémentaire indiquant l'état global de la demande. |
Dans ce guide complet, nous avons exploré l'univers essentiel de la vérification par mot de passe à usage unique (OTP) et expliqué comment l'intégrer facilement à votre boutique Shopify pour renforcer la sécurité et protéger les données clients sensibles. Nous avons abordé les concepts essentiels, les avantages et les instructions de mise en œuvre étape par étape. Vérification OTP sur votre boutique Shopify en utilisant l'application « miniOrange OTP Login ».
Ressources supplémentaires
Contactez-nous
Veuillez nous contacter à shopifysupport@xecurify.comNotre équipe vous accompagnera dans la configuration de l'application de connexion par code OTP pour Shopify. Elle vous aidera également à choisir la solution ou le forfait le mieux adapté à vos besoins.
