Tämän osion artikkelit

API – Tilaajat

Avatar
Creamailer Support
  • Päivitetty
Seuraa

API:n avulla voidaan lisätä, poistaa sekä päivittää tilaajien tietoja. Tilaajatietojen päivitystä varten tarvittava listan ID löytyy apin avulla tai Posituslistan asetukset -sivulta.

Kenttien kuvaus

Nimi Tyyppi Kijoitusoikeus Pakollinen Tiedot
email string kyllä kyllä Sähköpostiosoite. 2-100 merkkiä.
new email string kyllä ei Uusi sähköpostiosoite (osoitteen vaihtaminen). 2-100 merkkiä.
name string kyllä ei Tilaajan nimi. 2 – 100 merkkiä.
company string kyllä ei Yritys. 2 – 50 merkkiä.
address string kyllä ei Lähiosoite. 2 – 100 merkkiä.
city string kyllä ei Postitoimipaikka. 2 – 50 merkkiä.
zip_code number kyllä ei Postinumero. 2 – 5 merkkiä.
country string kyllä ei Maa. 2 – 20 merkkiä.
phone string kyllä ei Puhelin. 2 – 20 merkkiä.
customer_number string kyllä ei Asiakasnumero. 1 – 20 merkkiä.
subcribed_from string ei ei Mistä tilaaja lisätty. Muodostetaan automaattisesti. Vaihtoehdot: web = tilauslomakkeelta, admin = lisätty ylläpidosta
send_autoresponders boolean kyllä ei Lähetetäänkö postituslistan automaattiset viestit (oletus = ei).
send_autoresponders_if_exists boolean kyllä ei Lähetetäänkö postituslistan automaattiset viestit vaikka tilaaja olisi listalla (oletus = ei).
created datetime ei ei Tilaajan lisäyspäivämäärä (YYYY-MM-DD HH:MM:SS). Muodostetaan automaattisesti tilaajan lisäyksen yhteydessä.
status string kyllä ei Käyttäjän status. Vaihtoehdot: active = aktiivinen, unsubscribed = perunut uutiskirjeen, bounced = poistettu virheelinen takia (muodostetaan automaattisesti), spamreport = poistettu roskapostimerkkauksen takia (muodostetaan automaattisesti), deleted = poistettu ylläpitäjän toimesta.
  string,number,datetime kyllä ei Personoidut kentät. 2 – 255 merkkiä.

Tilaajien lisääminen

Toiminnon avulla voidaan lisätä tilaajia olemassa olevaan postituslistaan. Postituslistan automaattiset viestit lähetetään API-kutsun yhteydessä vain jos tilaaja on uusi ja kutsun mukana välitetän parametri send_autoresponders -> true.

Yksittäisen tilaajan lisääminen

{LISTID}: Listan id

POST /v1/api/subscribers/{LISTID}.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/subscribers/{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 '{"email":"erkki@esimerkki.com"}' -X POST

Oletettu kutsu (Json):

{ "email": "erkki@esimerkki.com", "name": "Erkki Esimerkki", "company": "Yritys", "address": "Mannerheimintie 1", "city": "Helsinki", "zip_code": "00100", "country": "Suomi", "phone": "040 123 456", "customer_number": "2345", "custom_fields": [ { "website": "http://example.com" }, ... ], "send_autoresponders": false }

Oletettu vastaus (Json):

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
 
{
  "success": true,
  "message": "Subscriber created"
}

Usean tilaajan lisääminen/päivittäminen

Toiminnon voidaan lisätä useita tilaajia. Huom. voit antaa tilaajan tiedoissa “update_existing”: “true” -parametrin, jonka avulla entuudestaan löytyvän tilaajan tiedot päivitetään.

{LISTID}: Listan id

POST /v1/api/subscribers/import/{LISTID}.{xml|json|php}

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/subscribers/import/{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 '{"Subscribers":[{"email": "erkki@esimerkki.com","name": "Erkki Esimerkki"},{"email": "pentti@esimerkki.com","name": "Pentti Esimerkki"}]}' -X POST

Oletettu kutsu (Json):

{
  "Subscribers": [
    {
      "email": "erkki@esimerkki.com",
      "name": "Erkki Esimerkki",
      "company": "Yritys",
      "address": "Mannerheimintie 1",
      "city": "Helsinki",
      "zip_code": "00100",
      "country": "Suomi",
      "phone": "040 123 456",
      "customer_number": "2345",
      "custom_fields": [
        {
          "website": "http://example.com"
        }
      ],
      "send_autoresponders": false
    },
    {
      "email": "tauno@esimerkki.com",
      "name": "Tauno Esimerkki"
    },
    {
      "email": "pentti@esimerkki.com",
      "name": "Pentti Esimerkki"
    },
    ...
}

Oletettu vastaus (Json):

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
 
{
  "subscribers_submitted":5,
  "subscribers_added":5,
  "subscribers_validation_errors":0,
  "subscribers_found":0,
  "subscribers_duplicate":0,
  "subscribers_suppressed":0
  "subscribers_updated":0
}

Oletettu vastaus virheen sattuessa (Json):

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
 
{
  "subscribers_submitted":5,
  "subscribers_added":1,
  "subscribers_validation_errors":1,
  "subscribers_found":2,
  "subscribers_duplicate":1,
  "subscribers_suppressed":0,
  "subscribers_updated":0,
  "subscribers_error_details":[
    {"email":"erkki@esimerkki","code":1,"message":"Tarkista sähköpostiosoite."},
    {"email":"erkki@esimerkki.fi","code":2,"message":"Subscriber found"},
    {"email":"pentti@esimerkki.fi","code":2,"message":"Subscriber found"},
    {"email":"tauno@esimerkki.fi","code":3,"message":"Duplicate email"}
  ]
}

Tilaajan tiedot

Toiminnon avulla voidaan hakea yksittäisen tilaajan tiedot. Jos haluat hakea kaikki listan tilaajat, se onnistuu listan toiminnoista.

{LISTID}: Listan id email: Tilaajan sähköpostiosoite

GET /v1/api/subscribers/{LISTID}.{xml|json|php}?email=erkki@esimerkki.com

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/subscribers/{LISTID}.json?email=erkki@esimerkki.com -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
 
{
  "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"},
    ...
  ]
}

Tilaajan päivittäminen

Toiminnon voidaan päivittää yksittäisen tilaajan tiedot. Huom! Jos haluat päivittää sähköpostiosoitteen, voi tehdä sen käyttämällä new_email parametriä.

{LISTID}: Listan id

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

cURL esimerkki:

curl -i https://api.cmfile.net/v1/api/subscribers/{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 '{"email":"erkki@esimerkki.com","name":"Erkki Esimerkki"}' -X PUT

Oletettu kutsu (Json):

{
  "email": "erkki@esimerkki.com",
  "name": "Erkki Esimerkki",
  "company": "Yritys",
  "address": "Mannerheimintie 1",
  "city": "Helsinki",
  "zip_code": "00100",
  "country": "Suomi",
  "phone": "040 123 456",
  "customer_number": "2345",
  "status": "active",
  "custom_fields": [
    {
      "website": "http://example.com"
    },
    ...
  ]
}

Oletettu vastaus (Json):

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

Tilaajan poistaminen

Toiminnon avulla voidaan poistaa tilaajia aktiivisista tilaajista. Tilaajan statukseksi päivitetään ‘deleted’ eli poistettu ylläpitäjän toimesta. Tilaajan statuksen päivittämiseen voidaan käyttää Tilaajan päivitys -toimintoa jossa voit määritellämyös muita statuksia kuten ‘unsubscribed’.

{LISTID}: Listan id email: Tilaajan sähköpostiosoite

DELETE /v1/api/subscribers/{LISTID}.{xml|json|php}?email=erkki@esimerkki.com

cURL esimerkki: curl -i https://api.cmfile.net/v1/api/subscribers/{LISTID}.json?email=erkki@esimerkki.com -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": "Subscriber unsubscribed"
}

Aiheeseen liittyvät artikkelit

Kommentit

0 kommenttia

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