O serviço está localizado na URL: << URL base do sistema >> / api-wsdl.php

(Para acessar as definições do WSDL você deve usar api-wsdl.php? Wsdl)

Os serviços oferecidos são os seguintes:

• cancelar a inscrição
• deInformação
• sendEmail
• sendEmails

unsubscribe e deInformação têm a mesma assinatura definida para acesso através de api.php e sua operação é a mesma definida na documentação anterior.

Os outros dois serviços foram modificados a partir da operação documentada acima.

 

enviarEmail y enviarEmails

A operação é análoga à descrita acima, mas mudanças foram feitas no nível do parâmetro para eliminar dados polimórficos.

Os parâmetros esperados para enviar e-mail o seguinte:

<enviarEmail>
<suscripto>
<email>EMAIL DEL SUSCRIPTO</email>
[ <nombre>NOMBRE DEL SUSCRIPTO</nombre>      ]
[ <apellido>APELLIDO DEL SUSCRIPTO</apellido>]
[<tags> ESTRUCTURA DE TAGS</tags>]
</suscripto>
<campanaId>ID DE LA CAMPAÑA</campanaId>
<soloSuscribir>Booleano</soloSuscribir> 
<email>
[<viaUrl>DIRECCION DE LA PIEZA</viaUrl>]
[<piezaEnUtf8>0 ó 1</piezaEnUtf8>]
[<piezaFija>DIRECCION DE PIEZA FIJA</piezaFija>]
[<asunto>ASUNTO DE E-MAIL</asunto>]
[<tags> ESTRUCTURA DE TAGS</tags>]
</email>
<serverKey>SERVER KEY</serverKey>
</enviarEmail>

E para enviar e-mails:

<enviarEmails>
<suscriptos>
<item>
<email>EMAIL DEL SUSCRIPTO</email>
[ <nombre>NOMBRE DEL SUSCRIPTO</nombre>      ]
[ <apellido>APELLIDO DEL SUSCRIPTO</apellido>]
[<tags> ESTRUCTURA DE TAGS</tags>]
</item>
⇓
<item>
<email> EMAIL DE OTRO SUSCRIPTO </email>
⇓
</item>
</suscriptos>
<campanaId>ID DE LA CAMPAÑA</campanaId>
<soloSuscribir>Booleano</soloSuscribir> 
<email>
[<viaUrl>DIRECCION DE LA PIEZA</viaUrl>]
[<piezaEnUtf8>0 ó 1</piezaEnUtf8>]
[<piezaFija>DIRECCION DE PIEZA FIJA</piezaFija>]
[<asunto>ASUNTO DE E-MAIL</asunto>]
</email>
<serverKey>SERVER KEY</serverKey>
</enviarEmails>

Comentários:

• No envio de e-mail, os campos de tags podem aparecer tanto em inscritos como em e-mails. Se estiver presente em ambos, o presente em inscritos será priorizado.
• O booleano justSubscribe foi adicionado, o que determina que o processo terminou com a inserção do assinante (ou dos assinantes) sem enviar e-mails. Isso substitui a operação da API anterior (api.php) definindo o campo de email como 0 (zero) ou false. Agora, um campo de e-mail vazio indica apenas que todos os valores necessários do DMDS são obtidos  (os dados carregados na campanha) e não influenciam se os e-mails serão enviados ou não.
• Os colchetes [], como de costume, indicam um campo opcional.
• A estrutura do tag também foi modificada para evitar o polimorfismo. Continuamos a detalhar sua nova estrutura

Estrutura de Tags

Formato:

<tags>
   [
   <simples>
   <item>
      <tag>Valor de un tag simple</tag>
      <reemplazo>Reemplazo para el tag</reemplazo>
   </item>
   <item>
      ⇓
   </item>
   </simples]
   [
   <complejos>
   <item>
      <tag>Valor de un tag complejo</tag>
      <atributos>
         <item>
            <atributo>
               Valor de un atributo
            </atributo>
            <reemplazo>Reemplazo para tag.atributo</reemplazo>
         </item>
         <item>
            ⇓
         </item>
      </atributos>
   </item>
   <item>
      ⇓
   </item>
   </complejos]
   [
   <repeat>
      [
      <simples>
         <item>
            <tag> Valor del Tag Repeat Simple </tag>
            <reemplazos>
               <item>1º Reemplazo</item>
               <item>2º Reemplazo</item>
               <item>...Más Reemplazos para el tag...</item>
            </reemplazos>
         </item>
         <item>..Más Tags...</item>
      </simples>
      ]
      [
      <complejos>
         <item>
            <tag> Valor del Tag Repeat Complejo </tag>
            <atributos>
               <item>
                  <item>
                     <atributo>Atributo 1</atributo>
                     <reemplazo>
                        1º Reemplazo del Atributo 1
                     </reemplazo>
                  </item>
                  <item>
                     <atributo>Atributo 2</atributo>
                     <reemplazo> 
                        1º Reemplazo del Atributo 2
                     </reemplazo>
                  </item>
                  <item> 
                     ...Más Pares (Atributo, Reemplazo) 
                  </item>
               </item>
               <item>
                  <item>
                     <atributo>Atributo 1</atributo>
                     <reemplazo>
                        2º Reemplazo del Atributo 1
                     </reemplazo>
                  </item>
                  <item>
                     <atributo>Atributo 2</atributo>
                     <reemplazo>
                        2º Reemplazo del Atributo 2
                     </reemplazo>
                  </item>
                  <item>
                     ...Más Pares (Atributo, Reemplazo)
                  </item>
               </item>
               <item>...Más Reemplazos para el Tag...</item>
            </atributos>
         </item>
         <item> ...Más Tags Repeat Complejos...</item>
      </complejos>
      ]
   </repeat>
   ]
</tags>

Os tipos dessas estruturas podem ser encontrados na definição do WSDL.

Se a mesma tag aparecer em mais de uma lista (simples, complexa, repetição simples, repetição complexa), sua aparência será priorizada na mesma ordem, ou seja, o sistema permanecerá com sua primeira aparição na seguinte ordem:

1. Simples

2. Complexo

3. Repetir-Simples

4. Complexo Repetitivo