Artículos en esta sección

Launch API (EN)

Avatar
Product Adoption Team
  • Actualización

Introduction

The Splio Customer Platform LAUNCH API provides resources for Splio Customers or partners to send an email to a specific Splio Customer Platform list. Email content is fetched from an authorized URL (see below) provided to the API. If every parameter is valid, the email is sent immediately to all contacts of each specified lists and/or filters. Once this is done you cannot modify the message or cancel the sending process. The process can however be paused from Splio Customer Platform if there are still un-queued mails.

Configuration

Before the API can be used the following configuration needs to be done:

  • creating a key for the API: this is done by Splio on demand and given to the customer.
  • creating a domain whitelist: the customer provides Splio with a complete list of all domains which may be used in contents URL and these domains are added to the whitelist of the customer's universe. All other domains will be rejected by the API, for security reasons.

Access

Base URL for Europe

https://s3s.fr/api/launch/nph-13.pl

Base URL for Asia

https://api.spl4cn.com/api/launch/nph-13.pl

Parameters

All the parameters except list and group are mandatory. However, you must provide
at least one list or one group or one file.

  • universe: (mandatory) ID of the universe in Splio Customer Platform
  • key: (mandatory) Authentication key generated during API setup
  • list: Numeric id or list of ids (comma-separated) of the targeted list(s). The id is the number in the column before the name on the Splio Customer Platform / Database / Lists page.
  • filter: Numeric id or list of ids (comma-separated) of the targeted filter(s). The id is the
    number in the column before the name on the Splio Customer Platform / Target / Filters
    page
  • file: Numeric id or list of ids (comma-separated) of the targeted files (9 characters)
  • url: (mandatory) URL where the content of sent email is fetched. The title of the page will be used as the message's subject
  • senderemail: (mandatory) Sender's email
  • sendername: (mandatory) Sender's name
  • replyto: Value of the message's reply to header (undefined by default)
  • starttime: Date at which the campaign should be sent. If in the past, the email will be sent immediately. The format must be the following: "yyyy-mm-dd HH:MM:SS" (time must be GMT, the API takes care of the conversion).
  • opcode: optional operation for the generated campaign
  • category: optional category for the generated campaign

Example

http://s3s.fr/api/launch/nph-13.pl?universe=customerunivers&key=123456abc
&url=http%3A%2F%2Fcustomer.com%2Fmessage.html&senderemail=sender@customer.co
m&sendername=Customer%20Name&list=1,2&filter=5&starttime=2013-12-21%2010:30:00

Response

Response Format

Data returned in response messages is always UTF-8 encoded and JSON formatted.
The unique response language is English.

Error Codes & Responses

Responses are returned as JSON objects that contain "code", "name" and "description"
attributes. "code" and "name" are the HTTP code and name response.

Examples of response

Example 1: 

{"code":200,"name":"OK","description":"ok"}

Example 2: 

{"code":404,"name":"Not Found","description":"specified resource does not exist"}

List of responses

  • 200 => OK, note an email will be sent if there are any optin contacts in the specified set resulting from lists and filter parameters
  • 400 => there is something wrong with the provided parameters (missing, incorrect format, invalid universe/key/URL, URL domain not in whitelist...). See returned message for more information.
  • 500 => Internal Server Error, Something is broken, please contact Splio.

Artículos relacionados