Tämän osion artikkelit

API - Postituslistat

Avatar
Creamailer Support
  • Päivitetty
Seuraa

API:n avulla voidaan lisätä, poistaa sekä päivittää postituslistoja.

Kenttien kuvaus

Nimi Tyyppi Kijoitusoikeus Pakollinen Tiedot
id integer ei ei Listan id. Muodostetaan automaattisesti listan lisäämisen yhteydessä.
name string kyllä kyllä Listan nimi. 2-50 merkkiä.
language string kyllä ei Listan oletuskieli on Suomi. 2 Merkkiä. Vaihtoehdot: fi – Suomi, en – Englanti, es – Espanja, nl – Alankomaat, it – Italia, fr – Ranska, se – Ruotsi, de – Saksa, da – Tanska, ru – Venäjä & ee – Eesti.
auto_suppress boolean kyllä ei Lisätäänkö virhelliset osoitteet estolistalle automaattisesti. Oletus true (suositus).
created datetime ei ei Listan lisäyspäivämäärä (YYYY-MM-DD HH:MM:SS). Muodostetaan automaattisesti listan luonnin yhteydessä.


Listan lisääminen

Toiminnon avulla luodaan postituslista, johon voidaan myöhemmin lisätä tilaajia. Listalle annetaan nimi, kieli sekä määritellään lisätäänkö mahdolliset virheelliset sähköpostiosoitteet estolistalle, jolloin niihin ei lähetetä viestejä jatkossa (suositus).

POST /v1/api/lists.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -H "Content-Type: application/json" -d '{"name":"Listan nimi","language":"fi","auto_suppress":true}' -X POST

Oletettu kutsu (JSON):

{
  "name": "Listan nimi",
  "language": "fi",
  "auto_suppress": true
}

Oletettu vastaus (JSON):

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
 
{
  "success": true,
  "message": "List added",
  "id": "1234"
}

Listan tiedot

Toiminnon avulla voit hakea listan perustiedot.

Yksittäinen lista (JSON):

{LISTID}: Listan id

`GET` /v1/api/lists/{LISTID}.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists/{LISTID}.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X GET

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "id": "1234",
  "name": "My list",
  "language": "fi",
  "auto_suppress":true,
  "created":"2013-09-13 10:37:22"
}

Kaikki listat (JSON):

`GET` /v1/api/lists.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X GET

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
 
{
  "Results": [
    {
      "id": "1234",
      "name": "My list",
      "language": "fi",
      "auto_suppress":true, 
      "created":"2013-09-14 10:37:22"
    },
    ...
  ]
}

Listan päivittäminen

Toiminnon avulla voidaan päivittää listan nimi sekä sen asetuksia.

{LISTID}: Listan id

PUT /v1/api/lists/{LISTID}.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists/{LISTID}.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -H "Content-Type: application/json" -d '{"name":"Listan nimi","language":"fi","auto_suppress":true}' -X PUT

Oletettu kutsu (JSON):

{ "name": "Listan nimi", "language": "fi", "auto_suppress": true }

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
 
{
  "success": true,
  "message": "List updated"
}

Listan tilaajat

Hae postituslistan tilaajat.

  • {LISTID}: Listan id

Valinnaiset parametrit

  • status: Tilaajien status jotka halutaan hakea, oletus all (all = kaikki, active = aktiiviset, unsubscribed = peruneet, bounced = virheelliset, spamreport = roskapostiksi merkanneet, deleted = poistettu ylläpidosta)
  • pagesize: – Montako riviä palautetaan per sivu, oletus 1000
  • page: – Sivu minkä tiedot palautetaan, oletus 0
  • date: – Päivämäärä jonka jälkeen lisätyt tilaajat halutaan hakea (YYYY-MM-DD), ei pakollinen
GET /v1/api/lists/subscribers/{LISTID}.{xml|json|php}?status={all|active|unsubscribed|bounced|spamreport|deleted}&pagesize=1000&page=1&date=2013-12-24

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists/subscribers/{LISTID}.json?status=active&pagesize=1000&page=1&date=2013-12-24 -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X GET

Oletettu vastaus (JSON):


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
 
{
  "Results": [
    { 
      "email": "erkki@esimerkki.com",
      "name": "Erkki Esimerkki",
      "company":"Esimerkki Oy", 
      "title":"Toimitusjohtaja",
      "address":"Mannerheimintie 1", 
      "city":"Helsinki", 
      "zip_code":"00100", 
      "country":"Suomi", 
      "phone":"010 123 456", 
      "customer_number":"123456", 
      "subcribed_from":"web", 
      "created":"2013-02-13 13:49:42", 
      "status":"active", 
      "custom_fields":[
            {"Esimerkkitietue 1":"Esimerkki data 1"},
            {"Esimerkkitietue 2":"Esimerkki data 2"},
             ...
            ]
    },
    ...
  ],
  "ordeder_by":"created",
  "order_direction":"asc",
  "page_number":0,
  "page_size":1000,
  "records_on_page":1,
  "total_number_of_records":1
}

Listan poistaminen

Postituslistan poistaminen toiminnon avulla.

{LISTID}: Listan id

DELETE /v1/api/lists/{LISTID}.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/lists/{LISTID}.json -H 'X-Access-Token:{ACCESS_TOKEN}' -H 'X-Request-Signature:{REQUEST_SIQNATURE}' -H 'X-Request-Timestamp: {TIMESTAMP}' -H "Accept: application/json; version=v1" -X DELETE

Oletettu vastaus (JSON):

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "success": true,
  "message": "List removed"
}

Aiheeseen liittyvät artikkelit

Kommentit

0 kommenttia

Kirjaudu sisään jättääksesi kommentin.