El servicio está ubicado en la URL: <<URL de base del sistema>>/api-wsdl.php

(Para acceder a las definiciones WSDL se debe utilizar api-wsdl.php?wsdl)

Los servicios ofrecidos son los siguientes:

• desuscribir
• dameInformacion
• enviarEmail
• enviarEmails

desuscribir y dameInformacion tienen la misma signatura que la definida para el acceso a través de api.php y su funcionamiento es el mismo que el definido en la documentación anterior.

Los otros dos servicios han sido modificados desde el funcionamiento documentado anteriormente.

enviarEmail y enviarEmails

El funcionamiento es análogo al descripto anteriormente, pero se han realizado cambios a nivel parámetros a fin de eliminar datos polimórficos.

Los parámetros esperados para enviarEmail los siguientes:

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

Y para enviarEmails:

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

Comentarios:

• En enviarEmail el campos tags puede aparecer tanto en suscripto como en email. Si está presente en ambas, se priorizará el presente en suscripto.
• Se agregó el booleano soloSuscribir, que determina que el proceso terminé con la inserción del suscripto (o los suscriptos) sin enviar emails. Esto reemplaza el funcionamiento que se tiene en el API anterior (api.php) seteando el campo email en 0 (cero) o false. Ahora un campo email vacío solo indica que se tomen todos los valores que sean necesarios del DMDS (los datos cargados en la campaña) y no influye sobre si se enviarán o no e-mails.
• Los corchetes [ ], como de costumbre, indican un campo opcional.
• La estructura de tags fue asimismo modificada para obviar el polimorfismo. Pasamos a detallar su nueva estructura

Estructura 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>

Los tipos de estas estructuras podrán encontrarse en la definición WSDL.

Si llegase a aparecer un mismo tag en más de una lista (simples, complejos, repeat-simples, repeat-complejos) se priorizará su aparición en ese mismo orden, es decir, el sistema se quedará con su primera aparición en el siguiente orden:

1. Simple
2. Complejo
3. Repeat-Simple
4. Repeat-Complejo