loader image

Dokumentacja API

Dokumentacja potrzebna w celu integracji innych systemów i aplikacji z systemem CSMART

Logowanie się użytkownika i pobranie tokena

REST API URL:
https://csmart.pl/app/api.php?module=Login

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • email – login użytkownika (wymagane)
  • hash – hasło użytkownika sha1 (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => Array 
     ( 
          [domain] => domena 
          [token] => token użytkownika 
      ) 
)

Pobranie listy klientów

REST API URL: https://csmart.pl/app/api.php?module=Accounts&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array
(
     [error] => Informacja o błędzie lub braku
     [data] => lista rekordów z danymi
)

Pobranie listy zadań

REST API URL: https://csmart.pl/app/api.php?module=Events&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Pobranie listy szans sprzedaży

REST API URL: https://csmart.pl/app/api.php?module=Opportunities&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Pobranie listy ofert

REST API URL: https://csmart.pl/app/api.php?module=Quotes&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Pobranie listy zamówień

REST API URL: https://csmart.pl/app/api.php?module=SalesOrders&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Pobranie listy faktur

REST API URL: https://csmart.pl/app/api.php?module=Invoices&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Pobranie listy produktów

REST API URL: https://csmart.pl/app/api.php?module=Products&action=List

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => lista rekordów z danymi 
)

Zapis klienta

REST API URL: https://csmart.pl/app/api.php?module=Accounts&action=Save

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)
  • id – wymagany w przypadku edycji rekordu
  • name – Nazwa
  • nip – Nip
  • type – Osoba/firma
  • category – Typ klienta
  • source – Źródło pozyskania
  • gr – Grupa
  • client_no – Tagi
  • au – Opiekun
  • email – E-mail
  • www – WWW
  • phone_office – Tel.
  • phone_mobile – Tel. kom.
  • phone_fax – Fax
  • facebook – Facebook
  • twitter – Twitter
  • address – Adres fakturowania
  • city – Miasto fakturowania
  • postal_code – Kod pocztowy fakturowania
  • state – Województwo fakturowania
  • country – Państwo fakturowania
  • shipping_address – Adres wysyłki
  • shipping_city – Miasto wysyłki
  • shipping_postal_code – Kod pocztowy wysyłki
  • shipping_country – Państwo wysyłki
  • bank_account_name – Bank
  • bank_account_number – Nr konta
  • payment_method – Metoda płatności
  • payment_days – Liczba dni płatności
  • description – Opis 1
  • description1 – Opis 2
  • description2 – Opis 3

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => id klienta 
)

Zapis zadania

REST API URL: https://csmart.pl/app/api.php?module=Events&action=Save

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)
  • id – wymagany w przypadku edycji rekordu
  • name – Temat (wymagany)
  • type – Typ (domyślnie: zadanie)
  • status – Status (nowe/zamknięte, domyślnie: nowe)
  • nip – NIP klienta (klient musi być w bazie)
  • date_start – Data rozpoczęcia (format: 2020-04-17, domyślnie: dzisiaj)
  • time_start – Czas rozpoczęcia (format: 13:50, domyślnie: dzisiaj)
  • date_end – Data zakończenia (format: 2020-04-17, domyślnie 09:00)
  • time_end – Czas zakończenia (format: 13:50, domyślnie: 09:00)
  • allDay – Zadanie całodniowe (0/1, domyślnie 0)
  • description – Opis 1
  • description1 – Opis 2
  • description2 – Opis 3

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => id zadania 
)

Zapis szansy sprzedaży

REST API URL: https://csmart.pl/app/api.php?module=Opportunities&action=Save

Parametry:

  • domain – domena systemu CSMART (wymagane)
  • token – token użytkownika pobrany podczas logowania (wymagane)
  • id – wymagany w przypadku edycji rekordu
  • name – Nazwa
  • status – Status
  • account_id – Kontrahent
  • account_name – Klient
  • source – Źródło pozyskania
  • final_date – Data finalizacji
  • total – Prognoza sprzedaży
  • assigned – Widoczne dla
  • process – Proces sprzedaży
  • description – Opis
  • sale_from – Źródło sprzedaży

Odpowiedź:

Array 
( 
     [error] => Informacja o błędzie lub braku 
     [data] => id szansy sprzedaży 
)
OK
Ta strona używa plików cookies. Przeczytaj Politykę Prywatności.