API pentru servicii de marketing prin e-mail

De la Planfix
Salt la: navigare, căutare

Acest API a fost dezvoltat pentru integrarea cu servicii externe de email. Permite gestionarea listelor de corespondență și a contactelor printr-un singur endpoint (de ex., https://yourserver.com/planfix_integration.php) și acceptă cereri în format JSON.

După ce ați implementat integrarea, puteți contacta Serviciul de Suport pentru a adăuga serviciul dvs. în lista de integrări disponibile utilizatorilor în interfața Planfix.

Conectarea la Planfix

  • Mergeți la secțiunea Administrare cont — Integrări — Marketing prin email pentru a conecta și configura integrarea.
  • În secțiunea deschisă, selectați Planfix API la sfârșitul listei.
  • Se va deschide o fereastră pentru setările integrării.
  • Trebuie să specificați adresa unde Planfix va trimite cererile și API Key-ul pentru autorizare.

Formatul cererii

Cererea se trimite prin metoda POST în format JSON către adresa specificată în setările integrării.

Exemplu de cerere: 

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

Parametrii cererii:

Nume Descriere Tip/Formát date Notă
action Acțiunea care trebuie efectuată string
authToken Token de autorizare pentru accesul API string
data Date în funcție de acțiune object

Acțiuni acceptate

createList — Creează o listă de corespondență

Descriere: Creează o listă de corespondență nouă cu numele specificat.

Cerere: 

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

'Răspuns (success): 

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

Răspuns (error): 

{
  "error": "Error description"
}

deleteList — Șterge o listă de corespondență

Descriere: Șterge o listă de corespondență după identificator.

Cerere: 

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

Răspuns (success): 

{
  "success": true
}

Răspuns (error): 

{
  "error": "Error description"
}

importContacts — Importă contacte într-o listă

Descriere: Importă contacte în lista de corespondență specificată.

Cerere: 

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

Răspuns (success): 

{
  "success": true
}

Răspuns (error): 

{
  "error": "Error description"
}

updateContact — Actualizează un contact

Descriere: Actualizează un contact din lista de corespondență. Suportă acțiunile: add, update, delete.


Cerere: 

{
  "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
  }
}

Răspuns (success): 

{
  "success": true
}

Răspuns (error): 

{
  "error": "Error description"
}

Important

  • Toate cererile trebuie să returneze un răspuns în format JSON.
  • În cazul unei erori, câmpul "error" cu descrierea erorii trebuie să fie întotdeauna prezent.
  • În cazul unui succes, câmpul "success": true trebuie să fie întotdeauna prezent.
  • Autorizarea se realizează prin câmpul "authToken" în fiecare cerere.
  • Toate câmpurile de tip text trebuie codificate în UTF-8.


Mergeți la