Como usar APIs OTP sem cabeçalho na loja Shopify

Visão geral

A segurança das contas e transações dos clientes é fundamental no mundo acelerado do e-commerce. Implementar a verificação de Senha Única (OTP) é uma maneira eficaz de aumentar a segurança e proteger informações confidenciais. Neste guia de API, mostraremos como habilitar a verificação de OTP em sua loja Shopify.

A Shopify é uma plataforma de e-commerce popular, conhecida por sua escalabilidade e flexibilidade, o que a torna uma excelente opção para empresas de todos os portes. Você pode adicionar uma camada extra de segurança às contas de usuários, aos processos de checkout e muito mais integrando a verificação OTP à sua loja Shopify.

Este guia passo a passo fornece instruções sobre como usar APIs OTP headless na sua loja Shopify usando o aplicativo miniOrange OTP Login.

Baixe Plugin

Planos de preços

Pré-requisito: Aplicativo de login OTP do Shopify

Para usar APIs OTP sem interface, você precisará instalar o Aplicativo de login miniOrange OTP na sua loja.

Consulte os nossos vídeo, para saber mais sobre como o Single-Sign-On funciona no Shopify.

Etapas de configuração

Guia passo a passo para integrar a verificação OTP na sua loja Shopify

Etapa 1: Criar cabeçalho de autenticação

Para usar nosso desafio e validar APIs Rest, você deve primeiro definir os cabeçalhos de autorização necessários para garantir que a solicitação seja feita por um usuário válido.
Os seguintes valores devem ser especificados no Cabeçalho de Solicitação HTTP. Será o mesmo para solicitações OTP e chamadas de validação OTP.

Atributo	Descrição
Chave do cliente	Sua chave de cliente.
Timestamp	O tempo em milissegundos em que a solicitação está sendo feita.
Autorização	Valor de hash SHA 512 composto pela chave do cliente, registro de data e hora atual e chave de API.

CÓDIGO DE AMOSTRA:

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; }

Etapa 2: Geração de OTP/Desafio da API REST

Você precisa fazer uma solicitação HTTP GET para nossa API REST de geração de OTP/Desafio para poder gerar OTP para o número de telefone/e-mail. Nossa API REST de Desafio aceita os seguintes parâmetros de solicitação:
Ponto final de geração de OTP: https://store.xecurify.com/moas/rest/shopify/api/auth/headless/otprequest

Parâmetros da solicitação:

Atributo	Descrição
Loja	O domínio da sua loja Shopify (myshopify) no qual o aplicativo miniOrange OTP Login/Register está instalado.
para	O endereço de e-mail ou número de telefone para onde você gostaria que enviássemos o OTP. Observação: o valor fornecido aqui deve estar presente na sua lista de clientes do Shopify
açao	Escreva o tipo de ação como "Conecte-se" or "registrar" de acordo com sua exigência

Você pode consultar a imagem para melhor compreensão das ações.

Login com OTP do Shopify - Ações de autorização

Ative a opção mostrada abaixo para Permitir login com OTP para novos usuários.

Login com OTP no Shopify - Permita que novos usuários façam login via OTP

Resposta JSON

A seguir está a resposta JSON gerada pela 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" }

Atributo	Descrição
txid	Este é o ID da transação para sua solicitação de geração. Você precisará salvar este valor na sessão. Ele precisará ser enviado na API de validação.
tipo de autorização	O método de autenticação. Neste caso, é o e-mail
Tipo de resposta	Isso mostra o tipo de resposta, ou seja, Resposta para solicitação de desafio ou solicitação de validação. Valores válidos: EM FOREX
entrega por telefone	Status de entrega por telefone. É fornecido caso a autenticação seja feita via celular.
Contacto	O número de telefone OTP foi enviado para o celular, por exemplo.
enviarStatus	Status do envio do contato acima. Valores válidos: SUCESSO, FALHA, ERRO.
enviarHora	Carimbo de data/hora mostrando a hora do envio.
mensagem	Uma mensagem adicional mostrando o status geral da solicitação.
estado	Status geral da solicitação de desafio/validação. Valores válidos: SUCESSO, FALHA, ERRO.

Etapa 3: Validação OTP / Verificação de desafio REST API

Para validar uma OTP, você precisa fazer uma solicitação HTTP GET para nossa API Validate Rest. Nossa API Validate Rest aceita os seguintes parâmetros de solicitação:
Nossa API de validação é: https://store.xecurify.com/moas/rest/shopify/api/auth/headless/otpverify

Parâmetros da solicitação:

Atributo	Descrição
txid	O ID da transação para a qual a solicitação foi gerada. Este é enviado como um parâmetro de resposta na API de Geração.
Loja	O domínio da sua loja Shopify (myshopify) no qual o aplicativo miniOrange OTP Login/Register está instalado.
para	O endereço de e-mail ou número de telefone para onde você gostaria que enviássemos o OTP.
otp	OTP recebido no seu celular/e-mail.

Resposta JSON

A seguir está a resposta JSON gerada pela API Validate Rest.


  /* JSON Response Object for Validation Request */
  { txId: "<UNIQUE_TRANSACTION_ID>" responseType: "VALIDATE" status:
  "SUCCESS" message: "Successfully Validated" }

Atributo	Descrição
txid	Este é o ID da transação para sua solicitação de geração.
Tipo de resposta	Isto mostra o tipo de resposta, ou seja, Resposta para Gerar solicitação ou Validar solicitação. Valores válidos: VALIDAR
estado	Status geral da solicitação de geração/validação. Valores válidos: SUCESSO, ERRO, FALHA.
mensagem	Uma mensagem adicional mostrando o status geral da solicitação.

Neste guia completo, exploramos o mundo vital da verificação de OTP (senha de uso único) e como ela pode ser perfeitamente integrada à sua loja Shopify para aumentar a segurança e proteger dados confidenciais de clientes. Abordamos os conceitos essenciais, benefícios e instruções passo a passo para a implementação. Verificação OTP na sua loja Shopify usando o aplicativo "miniOrange OTP Login".

Vamos Falar?

Entre em contato conosco em shopifysupport@xecurify.comNossa equipe ajudará você a configurar o aplicativo de login OTP do Shopify. Ajudaremos você a selecionar a solução/plano mais adequado às suas necessidades.

conteúdo