Net Promoter Score API

Enpies.com API Dökümantasyonu sayfasına hoş geldiniz.

API Desteği sayesinde, Enpies.com servislerini kurumsal uygulamalarınıza kolayca entegre edebilirsiniz.

X-API-PUBLIC ve X-API-PRIVATE Anahtarlarını Enpies.com panelinizde marka ayarları altındaki API sekmesinde bulabilirsiniz.

URL
https://api.enpies.com/v2/

Gönderimler

E-Posta ile Net Promoter Score Gönderimi oluşturmak ve izlemek için.

Gönderim Oluştur

Gönderim oluşturmak için.

Anahtar Tür Değer
list array Gönderim listesi
template string Anket teması kısa adı (slug)
language string (opsiyonel) Tema için dil seçimi. Atanmadığında, varsayılan olarak seçili temanın ana dili kullanılır.
delay string (opsiyonel) Gönderim için bekleme süresi değeri. Atanmadığında, now değeri alır. (Hemen: now) (Saat Sonra: x Hours) (Gün Sonra: x Days)
  • list[] dizisi en fazla 1000 ad. kayıt içerebilir.

list[]

Anahtar Tür Değer
email string Alıcı e-posta adresi
properties object Gönderime özel anahtar ve değerler

properties{}

Anahtar Tür Değer
ec_name string Alıcı adı
ec_surname string Alıcı soyadı
herhangi_bir_anahtar string, number Gönderime özgü anahtar ve değerler.
  • Özgün değerleri, önceden Enpies panelinizde tanımlamalısınız.
  • Tanımlayacağınız özgün değerler ec ön eki ile başlayamaz.
POST
/deliveries/deliver

Örnek İstek

curl -L -X POST "https://api.enpies.com/v/deliveries/deliver" -H "X-API-PRIVATE: MqHabDHcuIpKDydCmLiMyNUZYeUSTPOL4VX6nLAYaysSvaX6B7wm7TaJ9Bm998A9" -H "X-API-PUBLIC: UKDib1m312pFaQHSUBJj8FDOmDjfWUc1EfKdtKo2XqE3x1YcrwBMukCk72zBi26A" -H "Content-Type: application/json" --data-raw "{ 'list':[ { 'email':'musteri@alanadi.com', 'properties':{ 'ec_name':'Ad', 'ec_surname': 'Soyad', 'ozel_bir_deger': '123456789' } } ], 'template':'varsayilan', 'language':'tr','delay':'now' }"

İstek Değerleri

{
	"list":[
		{
			"email":"musteri@alanadi.com",
			"properties": {
				"ec_name":" Ad",
				"ec_surname": "Soyad",
				"ozel_bir_deger": "123456789"
			}
		}
	],
	"template":"varsayilan",
	"language":"tr",
	"delay":"now"
}

Örnek Cevap

{
	"success": true,
	"status": 200,
	"message": "Gönderimler Kuyruğa Eklendi."
}

Dönütler

Dönütleri Listele

Müşterilerden alınan dönütlerin listelenmesi.

Anahtar Tür Değer
date string Tarih aralığı bilgisi today, thisweek, thismonth, thisyear, yesterday, lastweek, lastmonth, lastyear, lastoneweek, lastonemonth, lastthreemonth,lastoneyear olarak verilebilir. Özel bir aralık belirlemek için 1576853984-1576853984 şeklinde Timestamp kullanılabilir.
template string (opsiyonel) Tema kısa adı.
group string (opsiyonel) Dönütler için NPS puan grubu. detractors, passives, promoters değerleri alabilir.
language string (opsiyonel) Tema temelindeki dönüt dili. tr, az, en, fr, it değerleri alabilir.
hasComment string (opsiyonel) Katılımcının yorumladığı/yorumlamadığı dönüt ayrımı için. yes değeri ile sadece katılımcı yorumu almış, no değeri ile katılımcı yorumu almamış dönütler getirilir.
limit number (opsiyonel) Sonuçlar arasında sayfalama için. Varsayılan değeri 20.
skip number (opsiyonel) Sonuçlar arasında sayfalama için.
GET
/feedbacks?

Örnek İstek

curl -L -X GET "https://api.enpies.com/v/feedbacks?date=lastoneyear" -H "X-API-PRIVATE: MqHabDHcuIpKDydCmLiMyNUZYeUSTPOL4VX6nLAYaysSvaX6B7wm7TaJ9Bm998A9" -H "X-API-PUBLIC: UKDib1m312pFaQHSUBJj8FDOmDjfWUc1EfKdtKo2XqE3x1YcrwBMukCk72zBi26A" -H "Content-Type: application/json"

Örnek cevap

{
  "success": true,
  "status": 200,
  "message": "Success",
  "payload": {
    "feedbacks": [
      {
        "unq": "cdHykJnBVAWkzT1M9LeEajXA4sDK",
        "unqShort": "4BRZPwSfJ6so",
        "people": {
            "email": "musteri@alanadi.com"
        },
        "template": {
          "questionIntro": "Merhaba, son alışverişinizi göz önünde bulundurarak;",
          "ultimateQuestion": "Mağazam'ı arkadaşlarınıza tavsiye etme olasılığınız nedir?",
          "language": "tr"
        },
        "answer": {
          "timeCreate": "2019-11-27 02:54",
          "score": 6,
          "comment": "Ürün paketlemesinde biraz daha özenli olsaydınız çok sevinirdim."
        },
        "deliveryType": "real",
        "properties": {
          "ec_brand_name": "Mağazam",
          "order_number": "95416884328"
        },
        "timeCreate": "2019-11-27 02:54"
      },
    ],
    "totalCount": 1,
    "realsCount": 1,
    "detractorsCount": 0,
    "passivesCount": 0,
    "promotersCount": 1,
    "npsScore": 100
  }
}

Dönüt Getir

Bir dönütü getirmek için kullanılır.

Anahtar Tür Değer
feedback string Dönüte ait unqShort anahtarı değeri.
GET
/feedback?feedback={unqShort}

Örnek istek

curl -L -X GET "https://api.enpies.com/v/feedback?feedback=W6ntWDCIjtBz" -H "X-API-PRIVATE: MqHabDHcuIpKDydCmLiMyNUZYeUSTPOL4VX6nLAYaysSvaX6B7wm7TaJ9Bm998A9" -H "X-API-PUBLIC: UKDib1m312pFaQHSUBJj8FDOmDjfWUc1EfKdtKo2XqE3x1YcrwBMukCk72zBi26A" -H "Content-Type: application/json"

Örnek Cevap

{
  "success": true,
  "status": 200,
  "message": "Success",
  "payload": {
    "feedback": {
      "unq": "cdHykJnBVAWkzT1M9LeEajXA4sDK",
      "unqShort": "4BRZPwSfJ6so",
      "people": {
          "email": "musteri@alanadi.com"
      },
      "template": {
        "questionIntro": "Merhaba, son alışverişinizi göz önünde bulundurarak;",
        "ultimateQuestion": "Mağazam'ı arkadaşlarınıza tavsiye etme olasılığınız nedir?",
        "language": "tr"
      },
      "answer": {
        "timeCreate": "2019-11-27 02:54",
        "score": 6,
        "comment": "Ürün paketlemesinde biraz daha özenli olsaydınız çok sevinirdim."
      },
      "deliveryType": "real",
      "properties": {
        "ec_brand_name": "Mağazam",
        "order_number": "95416884328"
      },
      "timeCreate": "2019-11-27 02:54"
    },
  }
}