Élektrondıq poşta marketïngi qızmetterine arnalğan API

Bul API sırtqı élektrondıq poşta qızmetterin ïntegracïyalaw üşin äzirlengen. Ol bir endpoint (mısalı, https://yourserver.com/planfix_integration.php) arqılı tizimder men kontaktilerdi basqarwğa mümkindik beredi jäne surawlardı JSON formatında qabıldaýdı.

Ïntegracïyanı jüzege asırğannan keýin, bizdiñ Support Service-ge xabarlasıp, qızmetiñizdi Planfix ïnterfeýsinde qoldanwşılarğa qoljetimdi ïntegracïyalar tizimine qosw twralı ötiniş bere alasız.

Planfix-pen qosılw

Ötinişti qosw jäne baptaw üşin Eseptik jazba basqarw — Ïntegracïyalar — Email marketing bölimine ötiñiz.
Aşılğan bölikte tizimniñ soñında Planfix API tañdañız.
Ïntegracïya baptawları terezesi aşıladı.
Planfix surawlar jiberetin mekenjaýdı jäne avtorïzacïya üşin API Key körsetwiñiz kerek.

Suraw formatı

Suraw POST ädisi arqılı ïntegracïya baptawlarında körsetilgen mekenjaýğa JSON formatında jiberiledi.

Suraw mısalı:

{
  "action": "action",
  "authToken": "your_authorization_token",
  "data": {
    // Data depending on the action
  }
}

Suraw parametrleri:

Atı	Sïpattaması	Tïp/Derekter formatı
action	Orındawğa tïis äreket	string
authToken	API-ğa ruqsat alw üşin avtorïzacïya tokeni	string
data	Äreketke baýlanıstı derekter	object

Qoldanılatın äreketter

createList — taratw tizimin qurw
deleteList — taratw tizimin joyu
importContacts — kontaktilerdi tizimge ïmporttaw
updateContact — kontaktini jañartw

createList — Taratw tizimin qurw

Sïpattama: Körsetilgen atawmen jaña taratw tizimin quradı.

Suraw:

{
  "action": "createList",
  "authToken": "your_authorization_token",
  "data": {
    "listName": "List name"
  }
}

'Jawap (sätti):

{
  "success": true,
  "listId": "unique_list_identifier""
}

Jawap (qate):

{
  "error": "Error description"
}

deleteList — Taratw tizimin joyu

Sïpattama: Taratw tizimin onıñ ïdentïfïkatorı boýınşa joyadı.

Suraw:

{
  "action": "deleteList",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier"
  }
}

Jawap (sätti):

{
  "success": true
}

Jawap (qate):

{
  "error": "Error description"
}

importContacts — Kontaktilerdi tizimge ïmporttaw

Sïpattama: Belgilengen taratw tizimine kontaktilerdi ïmporttaýdı.

Suraw:

{
  "action": "importContacts",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Name",
        "lastName": "Last name"
      }
    ]
  }
}

Jawap (sätti):

{
  "success": true
}

Jawap (qate):

{
  "error": "Error description"
}

updateContact — Kontaktini jañartw

Sïpattama: Taratw tizimindegi kontaktini jañartadı. Qoldaýtın äreketter: add, update, delete.

Suraw:

{
  "action": "updateContact",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "action": "add|update|delete",
    "contact": {
      "id": 123,
      "email": "email@example.com",
      "firstName": "First name",
      "lastName": "Last name"
    },
    "oldEmail": "old_email@example.com" // only for action=update
  }
}

Jawap (sätti):

{
  "success": true
}

Jawap (qate):

{
  "error": "Error description"
}

Mañızdı

Barlıq surawlar JSON formatında jawap qaýtarwı tïis.
Qate bolğan jağdaýda ärqaşan "error" örisinde qate sïpattaması körsetilwi tïis.
Sättilik bolğan jağdaýda ärqaşan "success": true örisi bolwı tïis.
Avtorïzacïya är surawdağı "authToken" örisi arqılı jüzege asadı.
Barlıq mätindik örister UTF-8 kodtawında bolwı tïis.

Ötw

API