Sugester API

Co to jest API?

API to zestaw reguł, który umożliwia przesyłanie danych między aplikacjami (np. między sklepem internetowym a systemem Sugester). Dzięki temu systemy mogą wysyłać i odbierać między sobą dane bez konieczności wdrażania skomplikowanych integracji.

Czym jest API w Sugesterze?

Nasze otwarte API pozwala zintegrować zewnętrzne aplikacje z Sugesterem. Dzięki niemu można np. dodawać do Sugestera klientów, tworzyć zadania czy wysyłać maile za pośrednictwem innego programu (pełną listę można znaleźć na np. https://github.com/sugester/API).

Polecamy też sprawdzić naszą stronę Api systemu Sugester.
 

Kto może korzystać z API Sugestera?

Każdy kto ma założone konto w Sugesterze i ma wiedzę techniczną może korzystać z API Sugestera. Aktywne konto w Sugesterze jest potrzebne, by uzyskać klucz dostępu i by rozpocząć integrację Sugestera z innymi systemami.
 

Jak uzyskać klucz API?

Aby uzyskać swój API token, należy się zalogować na swoje konto w Sugesterze i przejść do menu Ustawienia -> API.
Korzystając z tokena będzie można wywołać API nie podając za każdym razem swojego loginu hasła.

API token jest powiązany z kontem konkretnego użytkownika, a nie całym kontem w Sugesterze.
 

Co można zrobić dzięki API Sugestera?

• dodanie klienta
• pobranie danych klienta
• aktualizacja danych klienta
• skasowanie klienta
• dodanie kontaktu
• pobranie danych kontaktu
• aktualizacja danych kontaktu
• usunięcie kontaktu
• dodanie zadania
• pobranie listy zadań
• dodanie interesu
• dodanie nowej sugestii
• dodanie konta partnerskiego

Specyfikacja obiektów

Specyfikację dotyczącą API znajdziesz, wchodząc w Ustawienia>API. Nie jest ona kompletna. Pełny opis każdego obiektu w Sugesterze możesz uzyskać dopisując .json lub na końcu adresu URL, pod którym jest dostępny. Przykładowo żeby zobaczyć specyfikację obiektu "klient", zamień jego URL z:

https://nazwakonta.sugester.pl/app/clients/123456

https://nazwakonta.sugester.pl/app/clients/123456.json

Dodawanie klientów - duplikaty:

Jeśli chcesz, aby Sugester sprawdzał duplikaty klientów przy ich zakładaniu via API musisz przez API przekazać parametry:

[client][try_update]: true 
lub
[client][external_ids]:{'twojprogram':id_z_twojego_programu}

Pierwszy przypadek jest łatwiejszy.
Wtedy system będzie szukał i łączył po klientów po(w kolejności):

external_id external_ids (jak podasz jak wyżej)
NIP
email (system będzie też patrzył na kontakty)
telefon(po kontaktach też)
telefon komórkowy(po kontaktach też)


Specyfikacja obiektów:

{ "id": id posta "title": tytuł "content": treść "kind": rodzaj sugestii ('suggestion', 'error', 'question', 'praise', 'private'), "user_id": id usera "points": liczba punktów "nick": nick usera "votes_cache": ilość oddanych głosów "comments_cache": ilość oddanych komentarzy "forum_id": id forum "category_id": id category "created_at": czas utworzenia "updated_at": czas ostatniej modyfikacji "ip": ip z którego oddano post "agent": info o przeglądarce "response": odpowiedź główna "response_user_id": id osoby która odpowiedziała "referrer": refferer "responsible_id": id przypisanej osoby "last_action_status": status ("created"), "email": email nadawcy "uid": token użytkownika, "spam_kind": rodzaj spamu, "answer": odpowiedz, "answered": czy jest odpowiedz, "duplicate_from_id": id duplikatu, "abstract": abstrakt, "status_id": id status, "view_count": ilość wyświetleń, "tags": tagi, "facebook_likes": ilość like facebokoowych, "min_votes_to_start": ilość głosów do rozpoczęcia prac, "use_html": czy html, "email_to": adres email do, "email_cc": adres email cc, "email_bcc": adres email bcc, "spam_score": scoring spamowy, "spam_report": info o spamie, "closed": czy zamkniete (true/false), "scheduled_at": przypisana data wykonania, "task_kind": rodzaj zadania ('feedback', 'email', 'task', 'help', 'chat', 'phone', 'lead', 'error', 'idea'), "priority": priorytet, "title_note": null, "user_spam_report": zgłoszenie spamu, "client_id": id klienta, "project_id": id projektu, "help_link": klucz linka pomocy, "help_content": treść pomocy, "post_id": id postu nadrzędnego, "www": strona www dodajacego post, "private": czy prywatny (true/false), "unread": czy nie przeczytany (true/false), "email_recipient": do kogo jest dany post (uzywane w helpdesk/mail), "email_reply_to": reply to (uzywane w helpdesk/mail) }