RestAPI
 

Do czego służy RestAPI?

RestAPI pozwoli na pełną integrację Czatera z własnym systemem lub systemami zewnętrznymi, które wykorzystujemy w swojej pracy.

Narzędzie to umożliwi między innymi eksport pozyskanych za pośrednictwem czatu danych, np. treści rozmów i wiadomości offline, danych dotyczących klientów do używanego CRM.

RestAPI pozwala także automatyzację procesów, np. w sytuacji, gdy w firmie mamy dostępną infolinię, w momencie gdy klient telefonuje i zostaje to zanotowane w systemie centrali telefonicznej, automatycznie można uruchomić dla tej czynności metodę API Czatera i zostanie to odnotowane w CRM.

Jakie są dostępne metody?

Na ten moment dostępne są następujące metody:

• Pobranie bazy klientów
  
  POST https://s2.czater.pl/api
  {
  "type": "clients",
  "apiKey": "xxxxxx",
  "offset": "0"
  }
  
  Indywidualny klucz API można pobrać ze strony: https://www.czater.pl/userPanel/api (zawartość dostępna dla zalogowanych użytkowników).
  
  3 obligatoryjne parametry:
  - type: "clients"
  - apiKey - twój klucz API
  - offset - numer klienta, od którego rozpoczyna się pobieranie.
  
  Dane zwracane są w paczkach po 100 rekordów w formacie JSON.

• Dodanie nowego klienta
  
  POST https://s2.czater.pl/api
  {
  "type": "add-client",
  "apiKey": "xxxxxx",
  "name": "name",
  "email": "email",
  "directional": "48",
  "phone": "phone",
  "skype": "skype",
  "custom": "custom",
  "description": "description"
  }
  
  2 obligatoryjne parametry:
  - type: "add-client"
  - apiKey - twój klucz API
  Kolejnymi parametrami możesz sprecyzować dane klienta.

• Czy klient online
  
  POST https://s2.czater.pl/api
  {
  "type": "client-online",
  "apiKey": "xxxxxx",
  "name": "name",
  "email": "email",
  "phone": "phone",
  "skype": "skype"
  }
  
  2 obligatoryjne parametry:
  -type: "client-online"
  -apiKey - twój klucz API
  Kolejnymi parametrami możesz sprecyzować dane klienta.

• Pobranie bazy klientów
  
  GET https://s2.czater.pl/api?apiKey=xxxxxx&offset=0&type=clients
  lub:
  GET https://s2.czater.pl/api?apiKey=xxxxxx&id=0&type=clients
  
  3 obligatoryjne parametry:
  -type: "client"
  -apiKey - twój klucz API
  -offset - numer, od którego rozpoczyna się pobieranie
  lub id - unikalny identyfikator klienta.
  Dane zwracane są w paczkach po 100 rekordów w formacie JSON.
  

• Pobieranie czatów
  
  GET https://s2.czater.pl/api?apiKey=xxxxxx&offset=0&type=conv
  lub:
  GET https://s2.czater.pl/api?apiKey=xxxxxx&id=0&type=conv
  
  3 obligatoryjne parametry:
  -type: "conv"
  -apiKey - twój klucz API
  -offset - numer, od którego rozpoczyna się pobieranie
  lub id - unikalny identyfikator klienta.
  Dane zwracane są w paczkach po 100 rekordów w formacie JSON.
  

• Pobieranie widomości offline
  
  GET https://s2.czater.pl/api?apiKey=xxxxxx&offset=0&type=message
  lub:
  GET https://s2.czater.pl/api?apiKey=xxxxxx&id=0&type=message
  
  3 obligatoryjne parametry:
  -type: "message"
  -apiKey - twój klucz API
  -offset - numer, od którego rozpoczyna się pobieranie
  lub id - unikalny identyfikator klienta.
  Dane zwracane są w paczkach po 100 rekordów w formacie JSON.
  

• Pobieranie rozmów telefonicznych
  
  GET https://s2.czater.pl/api?apiKey=xxxxxx&offset=0&type=call
  lub:
  GET https://s2.czater.pl/api?apiKey=xxxxxx&id=0&type=call
  
  3 obligatoryjne parametry:
  -type: "call"
  -apiKey - twój klucz API
  -offset - numer, od którego rozpoczyna się pobieranie
  lub id - unikalny identyfikator klienta.
  Dane zwracane są w paczkach po 100 rekordów w formacie JSON.
  

• Połączenie telefoniczne
  
  POST https://s2.czater.pl/api
  {
  "type": "request-call",
  "apiKey": "xxxxxx",
  "clientDir": "48",
  "clientNum": "000000000"
  }
  
  4 obligatoryjne parametry:
  -type: "request-call"
  -apiKey - twój klucz API
  -clientDir - kierunkowy klienta
  -clientNum - numer telefoniczny klienta
  

• Pobranie treści czatu
  
  GET https://s2.czater.pl/api?apiKey=xxxxxxx&id=0&type=convCont
  
  3 obligatoryjne parametry:
  -type: "convCont"
  -apiKey - twój klucz API
  -id - unikalny identyfikator czatu
  

• Pobranie treści czatu
  
  GET https://s2.czater.pl/api?apiKey=xxxxxx&type=cons
  
  2 obligatoryjne parametry:
  -type: "cons"
  -apiKey - twój klucz API
  

Jakie metody dostępne będą w przyszłości?

Ponieważ cały czas pracujemy nad rozwojem API, w przyszłości dostępne będą także metody:

• Dodanie, edycja, pobranie listy akcji automatycznych
• Dodanie, edycja, pobranie listy przypomnień
• Pobranie statystyk