API Шаблон

Легко создавайте электронные письма с нашим гибким API

Email Template Design Api

CreateTemplate()

Используйте этот метод, чтобы создать новый шаблон.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

  • name (Требуется)

Имя создаваемого шаблона.

  • subject (Требуется)

Строка темы нового шаблона.

  • htmlbody (Требуется)

Html-тело страницы нового шаблона.

  • textbody (Требуется)

Тело обычного текста нового шаблона.

При успешном завершении этот метод возвращает ответ «успех» (код 0). Также в поле template_id будет указан уникальный ID номер недавно созданного шаблона. В противном случае будет возвращен код ошибки с описанием.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateTemplate xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
      <name>string</name>
      <subject>string</subject>
      <htmlbody>string</htmlbody>
      <textbody>string</textbody>
    </CreateTemplate>
  </soap:Body>
</soap:Envelope>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateTemplateResponse xmlns="http://api.directiq.com/">
      <CreateTemplateResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <template_id>int</template_id>
      </CreateTemplateResult>
    </CreateTemplateResponse>
  </soap:Body>
</soap:Envelope>

GetTemplates()

Используйте этот метод, чтобы получить список всех ваших email шаблонов.

  • apiKey (Требуется)

Ключ для аутентификации вашего приложения. Чтобы получить ваш ключ, кликните здесь.

При успешном завершении этот метод возвращает следующую информацию: template_id : уникальный ID номер шаблона template_name : название шаблона template_lastupdate : дата последнего обновления шаблона. В противном случае будет возвращен код ошибки с описанием.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTemplates xmlns="http://api.directiq.com/">
      <apiKey>string</apiKey>
    </GetTemplates>
  </soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTemplatesResponse xmlns="http://api.directiq.com/">
      <GetTemplatesResult>
        <success>boolean</success>
        <lastErr>string</lastErr>
        <errCode>int</errCode>
        <returnedLists>
          <getTemplateItem>
            <template_id>int</template_id>
            <template_name>string</template_name>
            <template_lastupdate>dateTime</template_lastupdate>
          </getTemplateItem>
          <getTemplateItem>
            <template_id>int</template_id>
            <template_name>string</template_name>
            <template_lastupdate>dateTime</template_lastupdate>
          </getTemplateItem>
        </returnedLists>
      </GetTemplatesResult>
    </GetTemplatesResponse>
  </soap:Body>
</soap:Envelope>