Table Of Content

SOAP API       Developer Guide    September 2012  www.silverpop.com  1‐866‐SILVPOP (745‐8767) © 2012 Silverpop Systems Inc. All Rights reserved. SOAP API     Table of Contents About This Guide & Legal .................................................................................................................................................5  Copyright, Trademark, and Distribution Notice ............................................................................................................5  Usage Disclaimer ..........................................................................................................................................................5  Target Audience ...........................................................................................................................................................5  Introduction .................................................................................................................................................................... 6  General Format ........................................................................................................................................................... 9  Submitting an API Request .......................................................................................................................................... 9  Responses .................................................................................................................................................................. 11  Mailing Management Interfaces ................................................................................................................................. 12  Send a Mailing to a Contact .................................................................................................................................... 12  Forward Mailing to a Friend .................................................................................................................................... 14  Database Management Interfaces – Contact .............................................................................................................. 15  Add a Contact ......................................................................................................................................................... 16  Double Opt‐in a Contact ......................................................................................................................................... 21  Update a Contact ................................................................................................................................................... 22  Opt‐out a Contact ................................................................................................................................................... 27  Select Contact Details ............................................................................................................................................. 31  User Interfaces ............................................................................................................................................................... 35  Session Management Interfaces ................................................................................................................................. 35  User Login .............................................................................................................................................................. 35  User Logout ............................................................................................................................................................ 36  Database Management Interfaces – User ................................................................................................................... 37  Import to a Database .............................................................................................................................................. 37  Export from a Database .......................................................................................................................................... 52  Add a Column to a Database ................................................................................................................................... 54  Get Database Details ..............................................................................................................................................56  List Contact Mailings .............................................................................................................................................. 61  Remove a Contact ................................................................................................................................................. 64  Get a List of Databases ...........................................................................................................................................65  2  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. Create a Relational Table ....................................................................................................................................... 69  Associate Relational Data with Contacts in a Database .......................................................................................... 72  Insert and Update Records in a Relational Table ..................................................................................................... 75  Delete Records From a Relational Table ................................................................................................................. 77  Import to a Relational Table .................................................................................................................................... 79  Export from a Relational Table ............................................................................................................................... 85  Purge Data from a Relational Table ....................................................................................................................... 88  Delete a Relational Table ....................................................................................................................................... 90  Create Contact List ................................................................................................................................................ 92  Add a Contact to a Contact List .............................................................................................................................. 93  Add a Contact to a Program ................................................................................................................................... 96  Create a Query of a Database ................................................................................................................................ 98  Calculate the Current Contacts for a Query ........................................................................................................... 103  Reporting Interfaces – User ...................................................................................................................................... 105  Export Tracking Metrics ........................................................................................................................................ 107  Export Raw Contact Events ................................................................................................................................... 111  Get a List of Report IDs for a Mailing ..................................................................................................................... 120  Get a List of Sent Mailings for an Org ................................................................................................................... 122  Get a List of Sent Mailings for a User .................................................................................................................... 127  Get a List of Sent Mailings for a Database ............................................................................................................. 131  Get Aggregate Tracking Metrics for a Mailing ....................................................................................................... 134  Get Aggregate Tracking Metrics for an Org .......................................................................................................... 141  Get Aggregate Tracking Metrics for a User ........................................................................................................... 147  Get Status of a Data Job ....................................................................................................................................... 158  Delete a Data Job .................................................................................................................................................. 163  Mailing Management Interfaces – User .................................................................................................................... 165  Schedule a Mailing ................................................................................................................................................ 165  Preview a Mailing Before Sending ........................................................................................................................ 169  Add a Dynamic Content Ruleset ........................................................................................................................... 172  Import a Dynamic Content Ruleset ....................................................................................................................... 179  Export a Dynamic Content Ruleset ....................................................................................................................... 187  List Dynamic Content Rulesets for a Mailing ......................................................................................................... 189  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API     Get Dynamic Content Ruleset Details ................................................................................................................... 192  Replace a Dynamic Content Ruleset ..................................................................................................................... 196  Validate a Dynamic Content Ruleset ..................................................................................................................... 201  Delete a Dynamic Content Ruleset ...................................................................................................................... 202  Get a List of Mailing Templates ........................................................................................................................... 204  Export a Mailing Template .................................................................................................................................... 207  Appendices .................................................................................................................................................................. 209  Frequently Asked Questions: Non Email Key (NEK) Databases ............................................................................... 209  API Error Codes ........................................................................................................................................................ 211        4  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. About This Guide & Legal  Copyright, Trademark, and Distribution Notice  This SOAP API Developer's Guide contains proprietary information, code, and programming data that is protected by  copyright. All rights are reserved. No part of this document may be photocopied, reproduced, or translated to another  language without prior written consent of Silverpop Systems Inc.  Usage Disclaimer  This document describes application programming interfaces (APIs) for automating certain functions of Silverpop  Engage.  The purpose of this document (and of the API in general) is to assist developers in automating the interactions between  their current software systems and Silverpop Engage. If used incorrectly, you can alter or delete critical data.  Usage of Silverpop’s SOAP API is generally governed by the same terms and conditions as set forth in your Silverpop  Engage License Agreement or Silverpop Services Agreement (an Agreement). Usage of Silverpop’s SOAP API is strictly  prohibited unless you have a valid, unexpired Agreement in place.  Specifically, Silverpop hereby grants you a limited, nonexclusive, nontransferable, nonsublicensable, worldwide right to  use the SOAP API in support of your development efforts only. All rights not expressly granted to you are reserved by  Silverpop.  You shall not (i) license, sublicense, sell, resell, transfer, assign, distribute or otherwise commercially exploit or make  available to any third party the SOAP API or Engage in any way; (ii) reverse engineer or access the SOAP API or Engage  in order to (a) build a competitive product or service, (b) build a product using similar ideas, features, functions or  graphics, or (c) copy any ideas, features, functions or graphics, except with Silverpop’s prior written approval in each  instance. Licenses cannot be shared or used by more than one individual.  Target Audience  This document describes a programmatic interface which uses the SOAP Protocol. The target audience is web  developers, programmers, and other IT professionals. Users should have knowledge of Internet technologies including:   Experience with SOAP    Experience with XML   Basic knowledge of XML Namespaces and XML Schema    Server‐side programming language (including PHP, Java/JSP, ASP, Perl)    FTP file transfers  If you need support related to the use of the SOAP API, please contact Client Support to open a support ticket.  5  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API   Introduction  Silverpop’s SOAP API library provides an efficient mechanism to accomplish many automation and integration  tasks. The public SOAP API interface defines standard requests and responses for the following functionality:  Session Management   User Login   User Logout  List Management   Add a Contact   Double Opt‐In a Contact   Update a Contact   Opt‐out a Contact   Select Contact Details  List Management User Actions   Import to a Database   Export from a Database   Remove a Contact   List Contact Mailings   Get a List of Databases   Get Database Details   Create a Contact List   Add a Contact to a Contact List   Create a Query of a Database   Calculate the Current Contacts for a Query   Add a Contact to a program   Create a Relational Table   Associate Relational Data with Contacts in a Database   Insert and Update Records in a Relational Table   Delete Records From a Relational Table   Import to a Relational Table   Export from a Relational Table   Purge Data from a Relational Table   Delete a Relational Table  6  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API       Mailing Management   Send a Mailing to a Contact   Forward Mailing to a Friend    Mailing Management User Actions   Preview a Mailing Before Sending   Schedule a Mailing   Get a List of Mailing Templates   Export a Mailing Template   Add a Dynamic Content Ruleset   Import a Dynamic Content Ruleset   Export a Dynamic Content Ruleset   List Dynamic Content Rulesets for a Mailing   Get Dynamic Content Ruleset Details   Replace a Dynamic Content Ruleset   Validate a Dynamic Content Ruleset   Delete a Dynamic Content Ruleset  Reporting   Export Tracking Metrics   Export Raw Contact Events   Get Report ID by Date   Get Sent Mailings for an Org   Get Sent Mailings for a User   Get Sent Mailings for a Database   Get Aggregate Tracking Metrics for a Mailing   Get Aggregate Tracking Metrics for an Org   Get Aggregate Tracking Metrics for a User   Get Status of a Data Job   Delete a Data Job    7  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API       To access the Silverpop Soap API, you need a Web Service Description Language (WSDL) file. The WSDL file  defines the Web service that is available to you. Your development platform uses this WSDL to generate an API  to access the Silverpop Web Service it defines. You can obtain the WSDL file via the following URL:     Pod  URL  1  http://api1.silverpop.com/SoapApi?wsdl  2  http://api2.silverpop.com/SoapApi?wsdl  3  http://api3.silverpop.com/SoapApi?wsdl  4  http://api4.silverpop.com/SoapApi?wsdl  5  http://api5.silverpop.com/SoapApi?wsdl    Each functional area described above has its own XML namespace and schema.  All schemas are located at  http://api[pod].silverpop.com/SoapApi/_resources_/xsd/.  The table below lists the available namespaces and  schemas.    Functional Area  Namespace  Schema  Session  SilverpopApi:EngageService.SessionMgmt.Login  SessionMgmt1.xsd  Management      List Management  SilverpopApi:EngageService.ListMgmt.RecipientActions  ListMgmt2.xsd      List Management  SilverpopApi:EngageService.ListMgmt.UserActions  ListMgmt‐ User Actions    UserActions.xsd    Mailing  SilverpopApi:EngageService.MailManagement  MailMgmt2.xsd  Management      Mailing  SilverpopApi:EngageService.MailManagement.UserActions  MailMgmt‐ Management User    UserActions.xsd  Actions  Reporting  SilverpopApi:EngageService.Reporting  Reporting1.xsd    8  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API     For each method listed in this document that has special usage with Non‐Email‐Key Lists (NEK Lists), there is a  section describing usage with NEK lists. Also see the Frequently Asked Questions section of the Appendices for  more information on using Engage SOAP API with NEK lists.   Note: NEK lists are only available for organizations with the Non‐Email‐Key option enabled.    General Format  API Requests are formatted as follows:  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns: [namespace prefix]  ="[namespace]">    <soapenv:Body>      <[namespace prefix]:[method]>        <[ namespace prefix]:[element]>[value]</[ namespace prefix]:[element]>      </[ namespace prefix]:[method]>    </soapenv:Body>  </soapenv:Envelope>    To pass parameters to the method call, list each parameter as a child element of the Method element, as shown  below:     <soapenv:Body>      <mail:SendMailing>        <mail:MailingId>1867084</mail:MailingId>        <mail:RecipientEmail>[email protected]</mail:RecipientEmail>      </mail:SendMailing>    </soapenv:Body>    Submitting an API Request  Submit each Engage API request to the endpoint specified in the table below. There are separate hardware and  software environments where we host Engage for our customers. The URL used to specify calls for the SOAP  API relates to the URL used when directly accessing Engage with a Web browser. For example, if your  organization accesses Engage data through the engage1.silverpop.com URL, you should use the SOAP API on  Pod 1 (api1.silverpop.com/SoapApi). If you access Engage through the engage2.silverpop.com URL, then you  should use the SOAP API on Pod 2.  9  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved. SOAP API       POD  Endpoint  1  api1.silverpop.com/SoapApi  2  api2.silverpop.com/SoapApi  3  api3.silverpop.com/SoapApi  4  api4.silverpop.com SoapApi  5  Api5.silverpop.com SoapApi    User Action requests require a session id for authentication.  The response of the login method returns a session  id as follows:    <envelope:Body>      <RESULT>        <SUCCESS>true</SUCCESS>        <SESSIONID>6BE58FD1938139D3010CB9E3662600B4</SESSIONID>        …..      </RESULT>    </envelope:Body>    This session id can be used to make subsequent authenticated API calls.  The session id is passed in the request  within the Header as shown below:    <soapenv:Header>      <ses:sessionHeader>        <ses:sessionid>6BE58FD1938139D3010CB9E3662600B4</ses:sessionid>      </ses:sessionHeader>    </soapenv:Header>    Session handling also has its own Namespace (SilverpopApi:EngageService.SessionHeader) to be included in  the request.     Note: The URLs listed here are subject to change as a result of adding additional servers to the Engage  environment. If you experience difficulty using these URLs, please verify the Engage server names with your  system administrator or account representative.  10  www.silverpop.com 1‐866‐SILVPOP (745‐8767)  © 2012 Silverpop Systems Inc. All rights reserved.

Description:
Calculate the Current Contacts for a Query . Usage of Silverpop's SOAP API is generally governed by the same terms and .. RECIPIENTS.
ebook img

SOAP API PDF

216 Pages·2012·0.88 MB·English
by  
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Download SOAP API PDF Free - Full Version

by Unknow| 2012| 216 pages| 0.88| English

Download SOAP API by in PDF format completely FREE. No registration required, no payment needed. Get instant access to this valuable resource on PDFdrive.to!

Free Download PDF

About SOAP API

Calculate the Current Contacts for a Query . Usage of Silverpop's SOAP API is generally governed by the same terms and .. RECIPIENTS.

Detailed Information

Author:Unknown
Publication Year:2012
Pages:216
Language:English
File Size:0.88
Format:PDF
Price:FREE
Download Free PDF

Safe & Secure Download - No registration required

Why Choose PDFdrive for Your Free SOAP API Download?

  • 100% Free: No hidden fees or subscriptions required for one book every day.
  • No Registration: Immediate access is available without creating accounts for one book every day.
  • Safe and Secure: Clean downloads without malware or viruses
  • Multiple Formats: PDF, MOBI, Mpub,... optimized for all devices
  • Educational Resource: Supporting knowledge sharing and learning

Free Books Similar to SOAP API

Frequently Asked Questions

Is it really free to download SOAP API PDF?

Yes, on https://PDFdrive.to you can download SOAP API by completely free. We don't require any payment, subscription, or registration to access this PDF file. For 3 books every day.

How can I read SOAP API on my mobile device?

After downloading SOAP API PDF, you can open it with any PDF reader app on your phone or tablet. We recommend using Adobe Acrobat Reader, Apple Books, or Google Play Books for the best reading experience.

Is this the full version of SOAP API?

Yes, this is the complete PDF version of SOAP API by Unknow. You will be able to read the entire content as in the printed version without missing any pages.

Is it legal to download SOAP API PDF for free?

https://PDFdrive.to provides links to free educational resources available online. We do not store any files on our servers. Please be aware of copyright laws in your country before downloading.

The materials shared are intended for research, educational, and personal use in accordance with fair use principles.

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
We use cookies

We use cookies to ensure you get the best browsing experience on our website. By clicking "Accept Cookies", you agree that we can store cookies on your device in accordance with our Terms and Privacy.