Streamsoft Firmino API

Dostęp do serwisu Streamsoft Firmino za pomocą formatu REST JSON.

Najważniejsze informacje

Punkt dostępowy

Punkt dostępowy znajduje się pod adresem: https://app.firmino.pl/app/services/rest/api/

Autoryzacja

Autoryzacja możliwa jest poprzez Basic Auth, która wymaga podania hasła i loginu do konta w każdym zapytaniu (hasło i login chronione są przez szyfrowane połączenie HTTPS).

Interfejs

Wymiana danych odbywa się w popularnym formacie JSON (więcej na temat samego formatu można znaleść tutaj https://pl.wikipedia.org/wiki/JSON ).

Zmiana kontekstu firmy

Domyślnie zapytania API wykonywane są w kontekście firmy przypisanej do konta użytkownika używanego do autoryzacji. W przypadku kont obsługujących wiele firm istnieje możliwość wskazania, której firmy dotyczy zapytanie.  Aby to zrobić, należy dodać do nagłówka HTTP parametr:

 

  "companyShortName": "NAZWA_SKROCONA_FIRMY"

 

companyShortName to skrócona nazwa firmy zdefiniowana w systemie.

Przykład

Pobranie kontrahentów dla dodatkowej firmy o nazwie skróconej „FIRMA_B”:

curl -X POST \
  --user login:haslo \
  -H "Content-Type: application/json" \
  -H "companyShortName: FIRMA_B" \
  https://app.firmino.pl/app/services/rest/api/customers

Jeżeli nagłówek companyShortName nie zostanie przekazany, zapytanie zostanie wykonane w domyślnym kontekście firmy przypisanej do użytkownika.

Moduły

Streamsoft Firmino API na chwilę obecną oferuje moduły:

Licencjonowanie

Streamsoft Firmino API dostępne jest bezpłatnie w ramach konta Podstawowego. Podstawowa wersja Streamsoft Firmino API umożliwia 500 zapytań / dobę.

Jeżeli potrzebujesz większych limitów bądź dodatkowych modułów skontaktuj się z nami wypełniając poniższy formularz.

    Dane przesłane w formularzu będą przetwarzane zgodnie z zasadami Polityki Prywatności Streamsoft Firmino.