# 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="/files/4d1a008364f239cf02d9d72e1c48271420a1067f" 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="/files/4aabfdc4b56df2fbb0fe3772c182e7ddaddb36a0" 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="/files/fc6abb201002931a65d183bbadd1044691498405" 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.offer18.com/pt/rede/integracao/integracao-de-otp.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.