API dla usług e-mail marketingowych

Z Planfix
Skocz do: nawigacja, szukaj

To API zostało opracowane w celu integracji z zewnętrznymi usługami e-mail marketingu. Pozwala zarządzać listami mailingowymi i kontaktami za pomocą jednego endpointu (np. https://yourserver.com/planfix_integration.php) i przyjmuje żądania w formacie JSON.

Po wdrożeniu integracji możesz skontaktować się z naszym Support Service, aby dodać swoją usługę do listy integracji dostępnych dla użytkowników w interfejsie Planfix.

Połączenie z Planfix

  • Przejdź do sekcji Account management — Integrations — Email marketing aby połączyć i skonfigurować integrację.
  • W otwartej sekcji wybierz na końcu listy Planfix API.
  • Otworzy się okno ustawień integracji.
  • Musisz podać adres, pod który Planfix będzie wysyłać żądania oraz klucz API do autoryzacji.

Format żądania

Żądanie wysyłane jest metodą POST w formacie JSON pod adres podany w ustawieniach integracji.

Przykład żądania: 

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

Parametry żądania:

Nazwa Opis Typ/format danych Uwaga
action Działanie, które ma zostać wykonane string
authToken Token autoryzacyjny do dostępu do API string
data Dane zależne od działania object

Obsługiwane akcje

createList — Create a mailing list

Opis: Tworzy nową listę mailingową o określonej nazwie.

Żądanie: 

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

'Odpowiedź (sukces): 

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

Odpowiedź (błąd): 

{
  "error": "Error description"
}

deleteList — Delete a mailing list

Opis: Usuwa listę mailingową po jej identyfikatorze.

Żądanie: 

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

Odpowiedź (sukces): 

{
  "success": true
}

Odpowiedź (błąd): 

{
  "error": "Error description"
}

importContacts — Import contacts into a List

Opis: Importuje kontakty do określonej listy mailingowej.

Żądanie: 

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

Odpowiedź (sukces): 

{
  "success": true
}

Odpowiedź (błąd): 

{
  "error": "Error description"
}

updateContact — Update сontact

Opis: Aktualizuje kontakt na liście mailingowej. Obsługuje akcje: add, update, delete.


Żądanie: 

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

Odpowiedź (sukces): 

{
  "success": true
}

Odpowiedź (błąd): 

{
  "error": "Error description"
}

Ważne

  • Wszystkie żądania muszą zwracać odpowiedź w formacie JSON.
  • W przypadku błędu pole "error" z opisem błędu musi być zawsze obecne.
  • W przypadku powodzenia pole "success": true musi być zawsze obecne.
  • Autoryzacja odbywa się poprzez pole "authToken" w każdym żądaniu.
  • Wszystkie pola tekstowe muszą być kodowane w UTF-8.


Przejdź do