# QI Tech — Lending-as-a-Service › Gerenciamento de notificações Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 6 página(s). Índice: - Não me perturbe (/documentation/emissao_de_divida/nao_me_perturbe) - Configuração de notificação (/documentation/notificacoes/configuracao_de_notificacao) - Configuração de template (/documentation/notificacoes/configuracao_template) - Gerenciamento de Notificações Personalizadas (/documentation/notificacoes/introducao) - Templates (/documentation/notificacoes/template) - Eventos (/documentation/notificacoes/tipos_de_evento) --- # Não me perturbe URL: /documentation/emissao_de_divida/nao_me_perturbe O "Não Me Perturbe" é uma plataforma criada pelas operadoras de telecomunicações que permite aos consumidores registrarem seus números de telefone para não receberem chamadas de telemarketing. No contexto do crédito consignado, sua utilização foi incorporada como uma das diretrizes da Autoregulação do Crédito Consignado, promovida por entidades como a Febraban, ABBC e CNF, com o objetivo de aumentar a proteção do consumidor e coibir práticas abusivas na oferta de crédito. Como instituição financeira aderente ao "Não Me Perturbe", implementamos um mecanismo de verificação prévia para garantir que não sejam realizadas ligações ativas para números de telefone cadastrados na lista de bloqueio. Por meio desta API, é possível consultar se um número específico está inscrito na base do "Não Me Perturbe" antes de iniciar qualquer tentativa de contato com o tomador de crédito. Essa checagem é essencial para assegurar o cumprimento das boas práticas de conduta comercial e o respeito à privacidade dos consumidores. :::caution Atenção É necessário realizar a consulta antes de realizar a ligação com o tomador. ::: ## Como usar Para realizar a consulta, é necessário enviar o número de telefone do tomador para o endpoint abaixo. ENDPOINT /do_not_disturb?phone_number=11999999999 MÉTODO GET :::caution Atenção O número de telefone deve ser enviado no formato DDD + Número, por exemplo: 11999999999. ::: ### Response STATUS 200 - Número encontrado na lista do "Não me perturbe" STATUS 404 - Número não encontrado na lista do "Não me perturbe" :::caution Atenção Caso o número seja encontrado na lista do "Não me perturbe", a ligação não deverá ser realizada. ::: --- # Configuração de notificação URL: /documentation/notificacoes/configuracao_de_notificacao Aqui demostraremos como você poderá escolher quais tipos de eventos serão notificados e por quais meios a notificação ocorrerá. :::warning Aviso Caso não exista uma configuração de notificação para um evento, você não receberá notificações do mesmo. ::: ## Criação de configuração de notificação ## Request ENDPOINT /notification/notification_configuration MÉTODO POST Request Body ```json { "callback": true, "email": true, "event_type": "account_transaction", "sms": true } ``` ## Response STATUS 201 Response Body ```json {"notification_configuration_key": "69850ae3-28bc-4779-a871-e73e1e883413"} ``` ## Listando configurações de notificação ## Request ENDPOINT /notification/notification_configurations MÉTODO GET ## Response STATUS 200 Response Body ```json { "data": [{ "event_type": "account_request", "sms_template": "b35ed5fc-fdda-4618-84e6-b49876dabf23", "template_configuration_key": "480521cc-b0c9-4938-bd11-0000be11c66b" }], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 1 } } ``` ## Atualização de configuração de notificação ## Request ENDPOINT /notification/notification_configuration/ NOTIFICATION_CONFIGURATION_KEY MÉTODO PUT Request Body ```json { "callback": true, "email": true, "event_type": "account_transaction", "sms": false } ``` ## Response STATUS 200 Response Body ```json {} ``` STATUS 4XX Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "descrição em portugues", "code": "codigo", "extra_fields": {} } ``` | Código HTTP | Código QI
`code` | Título
`title` | Descrição (eng)
`Description` | Descrição (ptbr)
`translation` | |-------------|----------------------|---------------------------------------|-------------------------------------------------|----------------------------------------------------------------------| | 400 | PMB000026 | Invalid notification for event type | Invalid notification method for event type | Método de notificação inválido para tipo de evento | --- # Configuração de template URL: /documentation/notificacoes/configuracao_template Esta configuração permite definir templates de SMS e e-mail para um evento. ## Criação de configuração de template ## Request ENDPOINT /notification/template_configuration MÉTODO POST Request Body ```json { "event_type": "bank_slip", "email_template_key": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ``` ## Response STATUS 201 Response Body ```json {"template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640d51"} ``` Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "descrição em portugues", "code": "codigo", "extra_fields": {} } ``` | Código HTTP | Código QI
`code` | Título
`title` | Descrição (eng)
`Description` | Descrição (ptbr)
`translation` | |-------------|----------------------|--------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------| | 400 | PMB000023 | Bad Request | Already exists an template configuration to this person and event type | Já existe um template configuration para essa pessoa e event type | ## Listagem de configuração de template ## Request ENDPOINT /notification/template_configurations MÉTODO GET ## Response STATUS 200 Response Body ```json { "data": [ { "event_type": "bank_slip", "sms_template": null, "template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640d51", "email_template": "e5c337db-dacc-4f1d-8a3e-919628640dd5" }, { "event_type": "account_transaction", "sms_template": null, "template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640ds1", "email_template": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ], "pagination": { "current_page": 0, "next_page": null, "rows_per_page": 10 } } ``` ## Atualização de configuração de template ## Request ENDPOINT /notification/template_configuration/ TEMPLATE_CONFIGURATION_KEY MÉTODO PUT Request Body ```json { "event_type": "bank_slip", "email_template_key": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ``` ## Response STATUS 201 Response Body ```json {} ``` STATUS 4XX Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "descrição em portugues", "code": "codigo", "extra_fields": {} } ``` | Código HTTP | Código QI
`code` | Título
`title` | Descrição (eng)
`Description` | Descrição (ptbr)
`translation` | |-------------|----------------------|--------------------|------------------------------------------|--------------------------------------------------------| | 400 | PMB000022 | Bad Request | The event type (event type) is not valid | O tipo de evento (tipo de evento) enviado não é válido | | 404 | PMB000024 | Not Found | Template configuration not found | Configuração de template não encontrada | --- # Gerenciamento de Notificações Personalizadas URL: /documentation/notificacoes/introducao Nossa plataforma oferece uma gama abrangente de opções de notificação, incluindo e-mails, mensagens SMS e webhooks, permitindo que os usuários escolham o canal que melhor se adapta às suas necessidades e preferências. Além disso, proporcionamos a capacidade de personalização por meio de templates para e-mails e SMS, garantindo que as notificações estejam alinhadas com a identidade e estilo de comunicação do usuário. Um dos aspectos mais notáveis do nosso sistema é a capacidade de os usuários definirem quando desejam receber notificações para eventos específicos. Essa flexibilidade permite uma gestão mais eficiente do fluxo de informações, garantindo que os usuários recebam apenas as notificações mais relevantes no momento mais oportuno. Nesta seção de documentação, detalharemos os diferentes aspectos do Gerenciamento de Notificações Personalizadas, desde a configuração inicial até a personalização avançada, proporcionando aos usuários uma compreensão abrangente de como aproveitar ao máximo essa funcionalidade essencial em nossa plataforma. --- # Templates URL: /documentation/notificacoes/template Aqui veremos como criar templates do tipo e-mail e sms, esses templates permitirão personalizar as mensagens de texto e email enviados em cada tipo de evento. Caso não seja configurado e a configuração esteja habilitada será enviado o template padrão da nossa plataforma. Obs: onde você desejar inserir uma variável customizada basta adicionar no texto '[nome_da_variável]' ## Criação de template SMS ## Request ENDPOINT /notification/template MÉTODO POST Request Body ```json { "template_type": "sms", "template": "Olá seu token e [name]" } ``` ### Body Params | Campo | Tipo | Descrição | Caracteres | |---|---| ---| ---| | `template_type` *| string | Tipo do template -> Valor default `sms` | - | | | `template` * | string | Texto do sms | 160 | ## Response STATUS 201 Response Body ```json { "template_key": "17f49953-29a1-439c-a6be-db37a32e2746" } ``` ## Criação de template E-mail :::warning Aviso O template de email se trata de um documento HTML compátivel com html para email. O mesmo deve ser encodado em base64. ::: ## Request ENDPOINT /notification/template MÉTODO POST Request Body ```json { "template_type": "email", "subject": "Título do email", "template": "<!DOCTYPE html>
<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" lang="en">
  <head>
    <title></title>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!--[if mso]>
				<xml>
					<o:OfficeDocumentSettings>
						<o:PixelsPerInch>96</o:PixelsPerInch>
						<o:AllowPNG/>
					</o:OfficeDocumentSettings>
				</xml>
				<![endif]-->
    <!--[if !mso]>
				<!-->
    <link href="https://fonts.googleapis.com/css?family=Montserrat" rel="stylesheet" type="text/css">
    <!--
					<![endif]-->
    <style>
      * {
        box-sizing: border-box;
      }

      body {
        margin: 0;
        padding: 0;
      }

      a[x-apple-data-detectors] {
        color: inherit !important;
        text-decoration: inherit !important;
      }

      #MessageViewBody a {
        color: inherit;
        text-decoration: none;
      }

      p {
        line-height: inherit
      }

      @media (max-width:620px) {
        .row-content {
          width: 100% !important;
        }

        .stack .column {
          width: 100%;
          display: with;
        }
      }
    </style>
  </head>
  <body style="background-color: #fff; margin: 0; padding: 0; -webkit-text-size-adjust: none; text-size-adjust: none;">
    <table class="nl-container" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #fff;">
      <tbody>
        <tr>
          <td>
            <table class="row row-1" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #000000; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="image_block" width="100%" border="0" cellpadding="20" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td>
                                  <div align="center" style="line-height:10px">
                                    <img src="https://9o37.mjt.lu/tplimg/9o37/b/1yz7i/hk3sp.png" style="display: block; height: auto; border: 0; width: 120px; max-width: 100%;" width="120" alt="placeholder logo" title="placeholder logo">
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-2" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #000000; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="heading_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td style="padding-bottom:20px;padding-left:20px;padding-right:20px;padding-top:60px;text-align:center;width:100%;">
                                  <h1 style="margin: 0; color: #000000; direction: ltr; font-family: Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif; font-size: 25px; font-weight: normal; letter-spacing: normal; line-height: 120%; text-align: center; margin-top: 0; margin-bottom: 0;">
                                    <strong>MANUTENÇÃO PROGRAMADA</strong>
                                    <br>
                                  </h1>
                                </td>
                              </tr>
                            </table>
                            <table class="text_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; word-break: break-word;">
                              <tr>
                                <td style="padding-bottom:80px;padding-left:20px;padding-right:20px;padding-top:60px;">
                                  <div style="font-family: sans-serif">
                                    <div style="font-size: 16px; mso-line-height-alt: 16.8px; color: #000000; line-height: 1.2; font-family: Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif;">
                                      <p style="margin: 0; font-size: 18px; text-align: left;">
                                        <br>Informamos que no dia <b>18 de fevereiro (domingo)</b>, a QI Tech realizará uma manutenção geral em todos os seus sistemas e serviços. Esta manutenção terá uma duração de três horas, tendo seu <strong>início às 02:00 (2AM)</strong> e seu <strong>término às 05:00 (5AM)</strong>.
                                      </p>
                                      <p style="margin: 0; font-size: 18px; text-align: left;">
                                        <br>
                                      </p>
                                      <p> Serviços <strong>indisponíveis</strong> durante a mannutenção: </p>
                                      </p>
                                      <ul>
                                        
                                        <li>Todos serviços relacionados ao Pix[name]</li>
                                        <li>Plataforma <strong>qitech.app</strong></li>
                                        <li>Todas as APIs</li>
                                        <li>APP Qi Conta</li>
                                      </ul>
                                      <p style="margin: 0; font-size: 16px; text-align: left; mso-line-height-alt: 16.8px;">&nbsp;</p>
                                      <p style="margin: 0; font-size: 16px; text-align: left;">Atenciosamente,</p>
                                    </div>
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-3" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #fff;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #fff; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-left: 20px; padding-right: 20px; padding-top: 0px; padding-bottom: 10px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="image_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td style="width:100%;padding-right:0px;padding-left:0px;">
                                  <div align="center" style="line-height:10px">
                                    <img src="https://9o37.mjt.lu/tplimg/9o37/b/1yz7i/hk3sp.png" style="display: block; height: auto; border: 0; width: 126px; max-width: 100%;" width="126">
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-4" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #fff; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="html_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td>
                                  <div style="font-family:Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif;text-align:center;" align="center">
                                    <div style="height:30px;">&nbsp;</div>
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
          </td>
        </tr>
      </tbody>
    </table>
    <!-- End -->
    <div style="background:#ffffff;background-color:#ffffff;margin:0px auto;max-width:600px;">
      <table align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="background:#ffffff;background-color:#ffffff;width:100%;">
        <tbody>
          <tr>
            <td style="border:0px solid #ffffff;direction:ltr;font-size:0px;padding:0px 30px 25px 30px;padding-bottom:25px;padding-left:30px;padding-right:30px;padding-top:0px;text-align:center;">
              <!--[if mso | IE]>
															<table role="presentation" border="0" cellpadding="0" cellspacing="0">
																<tr>
																	<td class="" style="vertical-align:top;width:540px;" >
																		<![endif]-->
              <div class="mj-column-per-100 mj-outlook-group-fix" style="font-size:0px;text-align:left;direction:ltr;display:inline-block;vertical-align:top;width:100%;">
                <table border="0" cellpadding="0" cellspacing="0" role="presentation" style="vertical-align:top;" width="100%">
                  <tr>
                    <td align="left" style="font-size:0px;padding:10px 25px;padding-top:0px;padding-bottom:0px;word-break:break-word;">
                      <div style="font-family:Arial, sans-serif;font-size:14px;letter-spacing:normal;line-height:1;text-align:left;color:#000000;">
                        <p class="text-build-content" style="text-align: center; margin: 10px 0; margin-top: 10px;" data-testid="24Y_bMRIoI">
                          <span style="color:#19247E;font-family:Roboto;font-size:14px;"></span>
                        </p>
                        <p class="text-build-content" style="text-align: center; margin: 10px 0; margin-bottom: 10px;" data-testid="24Y_bMRIoI">
                          <span style="color:#19247E;font-family:Roboto;font-size:14px;">
                            <a href="[[UNSUB_LINK_EN]]">
                              <br />
                              <br />
                            </a>
                          </span>
                        </p>
                      </div>
                    </td>
                  </tr>
                </table>
              </div>
              <!--[if mso | IE]>
																	</td>
																</tr>
															</table>
															<![endif]-->
            </td>
          </tr>
        </tbody>
      </table>
    </div>
    <!--[if mso | IE]>
									</td>
								</tr>
							</table>
							<![endif]-->
  </body>
</html>" } ``` ### Body Params | Campo | Tipo | Descrição | Caracteres | |---|---| ---| ---| | `template_type` *| string | Tipo do template -> Valor default `email` | - | | | `template` * | string | base64 do template | - | | `subject` * | string | Título do email | 80 | ## Response STATUS 201 Response Body ```json { "template_key": "17f49953-29a1-439c-a6be-db37a32e2746" } ``` ## Listando templates ## Request ENDPOINT /notification/templates MÉTODO GET ## Response STATUS 200 Response Body ```json { "data": [{ "template_key": "b35ed5fc-fdda-4618-84e6-b49876dabf24", "template_type": "sms", "template_status": "480521cc-b0c9-4938-bd11-0000be11c66b", "template": "Seu código é [code]" }], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 1 } } ``` --- # Eventos URL: /documentation/notificacoes/tipos_de_evento Os Eventos disparam notificações, com a listagem de eventos você adiquire o conhecimento sobre quais tipos de notificação poderá receber e quais os meios de recebimento (webhook, e-mail e sms). Os eventos posssuem os attributos allowed_sms, allowed_email e allowed_callback que indicam a possibilidade de envio de sms, e-mail ou callback respetivamente, além disso no caso de possibilidade de envio de email e sms podem conter o allowed_custom_vars que indicam as variáveis que podem ser substituidas no template utilizando o formato '[allowed_custom_var]' que será substituido pelo seu valor correspondente no envio. ## Consulta de eventos ## Request ENDPOINT /notification/event_types MÉTODO GET ### Query Params | Campo | Tipo | Descrição | |-------------|--------|----------------------------------------------| | `page` | number | Página a ser recuperada, valor defaul 0 | | `page_size` | number | Número de itens a ser recuperado, default 10 | ## Response STATUS 200 Response Body: Lista de tipos de eventos ```json { "data": [ { "event_type": "incoming_ted", "allow_sms": false, "allow_email": true, "allow_callback": true, "allowed_custom_vars": ["total_amount", "target_account_number", "target_document_number"] }, { "event_type": "outgoing_ted", "allow_sms": true, "allow_email": true, "allow_callback": false, "allowed_custom_vars": null } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 2 } } ```