> For the complete documentation index, see [llms.txt](https://knowledgebase.offer18.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.offer18.com/pt/rede/integracao/integracao-de-otp.md).

# Integração de OTP

O fluxo de oferta da API OTP (Senha de Uso Único) é um método de verificação servidor a servidor comumente usado em campanhas de Serviços de Valor Agregado para Celular (mVAS). Essas campanhas fornecem serviços adicionais além de chamadas básicas e SMS, como entretenimento, alertas e serviços de dados.

Usar a verificação OTP ajuda a:

* Melhorar a qualidade dos leads
* Reduzir fraudes
* Aumentar a confiabilidade geral da campanha

<figure><img src="https://4294454144-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2F8ACNtCRYGHhg9wDNITdr%2Fimage.png?alt=media&amp;token=fa8eb5d5-f8f3-4019-93a3-a5e18fc1f5a6" alt=""><figcaption></figcaption></figure>

### Como a API OTP funciona

#### **Gerar OTP**

* Quando um usuário envia seu número de celular em uma landing page, é gerado um OTP único e com validade limitada.
* O OTP é entregue por meio de uma chamada de API ao usuário e essa ação é registrada como um **click** no Offer18.

#### **Verificar OTP**

* O usuário insere o OTP recebido em seu dispositivo móvel.
* O OTP é validado por meio de uma chamada de API e isso é registrado como uma **conversão** no Offer18.

\
Para configurar a integração OTP, siga os passos abaixo:

1. Acesse Integração **»** Integração OTP
2. Em **"Credenciais"** seção, defina **"Nome"** para a integração
3. Adicione o **"OTP Send API URL" »** do anunciante adicione chaves e valores para o endpoint da API
4. Adicione **"OTP Verify API URL" »** do anunciante adicione chaves e valores para o endpoint da API
5. Enviar e Próximo

<figure><img src="https://4294454144-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2FDuDZ0jVTXqZOTeqWGKXJ%2Fimage.png?alt=media&amp;token=91c163ca-f675-4c0a-a665-f5e570d8754f" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Para a **"OTP Send API URL",** {msisdn} é um valor obrigatório.\
Para a **"OTP Verify API URL",** tanto {msisdn} quanto {otp} são valores obrigatórios.\
Se a API do anunciante exigir quaisquer parâmetros obrigatórios adicionais, adicione-os às chamadas de API correspondentes conforme necessário.
{% endhint %}

### Gerar endpoints de API OTP para os afiliados

1. Após enviar a configuração da API, prossiga para **"Affiliate API Endpoints".**
2. Adicione **"Título da Página"** para a landing page.&#x20;
3. Selecione o ID do Afiliado&#x20;
4. Clique **"Gerar"** para endpoints da API OTP e script da landing page

<figure><img src="https://4294454144-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2FeS2z2kgKirDCCXSyxyrl%2Fimage.png?alt=media&amp;token=341d091c-bf95-451c-b0e0-9d76aa442e04" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
O acesso à API deve estar habilitado para o afiliado.
{% endhint %}

### Resposta da API OTP

```javascript
Gerar OTP
{
  "status": "200",
  "response": "otp_sent_successfully",
}
```

```javascript
Verificar OTP
{
  "status": "200",
  "response": "otp_verified_successfully"
}
```

Para respostas com falha, verifique a resposta da API do seu anunciante.

***

### Script da Landing Page OTP

Baixe o script da landing page e compartilhe-o com seu afiliado para que ele possa integrá-lo ao aplicativo ou repositório dele. Se ele não tiver uma landing page dedicada, poderá usar este script diretamente como parte da configuração existente. A integração requer configuração mínima.

O script insere automaticamente o ID do Afiliado, as credenciais da API e outros parâmetros necessários com base no ID do afiliado selecionado na configuração. Todos os dados transacionais, como MSISDN e OTP, são preenchidos dinamicamente em tempo de execução durante o fluxo OTP, garantindo uma comunicação integrada entre a landing page e as APIs OTP.

> O script será baixado em PHP.