Skip to content

API pro služby e-mailového marketingu

Toto API bylo vyvinuto pro integraci s externími e-mailovými službami. Umožňuje spravovat mailing listy a kontakty přes jediný endpoint (např. https://yourserver.com/planfix_integration.php) a přijímá požadavky v JSON formátu.

Po implementaci integrace se můžete obrátit na naši Podporu, aby vaše služba byla přidána do seznamu integrací dostupných uživatelům v rozhraní Planfix.

Připojení k Planfixu

  • Přejděte do sekce Správa účtu — Integrace — Email marketing a připojte a nakonfigurujte integraci.
  • V otevřené sekci vyberte na konci seznamu Planfix API.
  • Otevře se okno nastavení integrace.
  • Musíte zadat adresu, na kterou má Planfix odesílat požadavky, a API Key pro autorizaci.

Formát požadavku

Požadavek se posílá metodou POST v JSON formátu na adresu uvedenou v nastavení integrace.

Příklad požadavku: 

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

Parametry požadavku:

Název Popis Typ/Formát dat Poznámka
action Akce, která má být provedena string
authToken Autorizační token pro přístup k API string
data Data v závislosti na akci object

Podporované akce

createList — Vytvořit mailing list

Popis: Vytvoří nový mailing list se zadaným názvem.

Request: 

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

'Response (úspěch): 

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

Response (chyba): 

{
  "error": "Error description"
}

deleteList — Smazat mailing list

Popis: Smaže mailing list podle jeho identifikátoru.

Request: 

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

Response (úspěch): 

{
  "success": true
}

Response (chyba): 

{
  "error": "Error description"
}

importContacts — Import kontaktů do listu

Popis: Importuje kontakty do zadaného mailing listu.

Request: 

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

Response (úspěch): 

{
  "success": true
}

Response (chyba): 

{
  "error": "Error description"
}

updateContact — Aktualizovat kontakt

Popis: Aktualizuje kontakt v mailing listu. Podporované akce: add, update, delete.

Request: 

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

Response (úspěch): 

{
  "success": true
}

Response (chyba): 

{
  "error": "Error description"
}

Důležité

  • Všechny požadavky musí vracet odpověď v JSON formátu.
  • V případě chyby musí být vždy přítomno pole "error" s popisem chyby.
  • V případě úspěchu musí být vždy přítomno pole "success": true.
  • Autorizace se provádí přes pole "authToken" v každém požadavku.
  • Všechna textová pole musí být kódována v UTF-8.

Přejít na

Citováno z „http://planfix.com/cs/help/index.php?title=API_pro_služby_e-mailového_marketingu&oldid=3084“