Integracje API

Dla: Administrator

Konfiguracja → Integracje → Integracje API łączy Prynt z innymi systemami drukarni, np. ze sklepem internetowym, programem księgowym albo CRM. Dzięki temu zamówienia, klienci czy stany magazynowe przechodzą między systemami bez przepisywania. Każde takie połączenie to osobna integracja API z własnym zakresem danych i własnymi kluczami.

O dostępie decyduje zespół Prynt. W Prynt składasz wniosek i potwierdzasz go kodem, a po akceptacji generujesz klucz. Klucz przekazujesz programiście, który buduje integrację.

Kto ma dostęp

Ekran widzi każdy, kto może przeglądać ustawienia systemu (rola Administrator).
Wnioski, klucze, wstrzymanie i archiwizację obsługuje osoba, która zarządza ustawieniami systemu (rola Administrator). Pozostali widzą integracje i klucze bez przycisków akcji. Tak samo jest z aplikacjami logującymi pracowników: wstrzymanie i wylogowanie osób wymagają zarządzania ustawieniami.
Działania integracji i Historię zmian widzi osoba, która może też przeglądać użytkowników — tak jak historię zmian w innych miejscach Prynt. Pozostali widzą w tym miejscu krótką informację, kto ma do nich dostęp.

Co widzisz

Lista integracji ma kolumny Integracja, Status, Zakresy, Aktywne klucze i Ostatnie użycie. Nad listą są przełącznik Pokaż zarchiwizowane oraz przyciski Złóż wniosek i Dokumentacja dla programistów. Ten drugi otwiera w nowej karcie opis API dla programisty. Dopóki drukarnia nie ma żadnej integracji, zamiast listy widać trzy kroki: wniosek, decyzja Prynt i klucz dla integracji.

Kliknięcie nazwy otwiera szczegóły integracji. Znajdziesz tam:

Klucze API: nazwę, końcówkę klucza (np. prynt_…q9Zk), autora, datę utworzenia, Ważny do, Ostatnie użycie i status klucza,
zakres danych: Wnioskowany zakres, Przyznany zakres albo Zakres z wniosku (po odrzuceniu),
Szczegóły: cel integracji, kontakt techniczny, Akceptacja Prynt ważna do, Limit zapytań oraz przebieg wniosku w sekcji Wnioski i decyzje. Gdy do końca akceptacji zostaje mniej niż 30 dni, przy dacie pojawia się ostrzeżenie. Aby ją przedłużyć, skontaktuj się z zespołem Prynt,
Działania integracji: co integracja zmieniła w danych drukarni, od najnowszych, np. kalkulacje przyjęte z poprzedniego systemu albo zamówienia ze sklepu. Przy każdym wpisie jest rodzaj danych (np. Kalkulacja), jej numer albo nazwa, data i link otwórz, który prowadzi do tej kalkulacji, zamówienia czy klienta. Starsze wpisy wczytasz przyciskiem Załaduj starsze. Dopóki integracja niczego nie zmieniła, zobaczysz komunikat Integracja nie wykonała jeszcze żadnych zmian,
Historia zmian: wnioski, decyzje Prynt, wstrzymania i zdarzenia kluczy, z autorem i datą.

Statusy integracji

Status	Co oznacza
Oczekuje na decyzję Prynt	Wniosek czeka na decyzję. Przy nim jest kod wniosku.
Aktywna	Prynt zaakceptował wniosek, a klucze działają.
Odrzucona	Prynt nie przyznał dostępu.
Wstrzymana	Integrację wstrzymała drukarnia. Klucze nie działają do wznowienia.
Zawieszona przez Prynt	Prynt zawiesił dostęp. Klucze nie działają. Skontaktuj się z zespołem Prynt.
Akceptacja wygasła	Minęła data ważności akceptacji. Klucze nie działają, dopóki Prynt jej nie przedłuży.
Dostęp do API wyłączony	Prynt wyłączył dostęp do API dla całej drukarni. Nie działa żadna integracja.
Zarchiwizowana	Integracja jest zamknięta na stałe, a jej klucze unieważnione. Widać ją po Pokaż zarchiwizowane.

Status klucza: Aktywny, Wygasa po rotacji (stary klucz działa jeszcze przez wybrany czas), Wygasł albo Unieważniony. Klucz, który wygasa w ciągu 30 dni, ma przy dacie znak ostrzegawczy.

Co możesz zrobić

Złóż wniosek o integrację

Kliknij Złóż wniosek.
W polu Nazwa integracji wpisz nazwę, np. „Sklep internetowy”. Pod tą nazwą integracja będzie widoczna jako autor zmian w historii.
W polu Do czego służy opisz, co integracja ma robić, np. „Zamówienia ze sklepu trafiają do Prynt, a sklep pokazuje klientom ich status”.
W polu Kontakt techniczny wpisz e-mail albo telefon osoby lub firmy, która buduje integrację.
W sekcji Zakres danych zaznacz obszary, do których integracja ma mieć dostęp. Zakres ze znacznikiem Dane osobowe daje dostęp do danych klientów i osób kontaktowych. Zakresu z dopiskiem Jeszcze niedostępny w API Prynt nie da się jeszcze wybrać.
Zaznacz akceptację Warunki korzystania z API i kliknij Wyślij wniosek. Przy zakresach z danymi osobowymi akceptujesz też zasady dotyczące danych osobowych. Treść warunków przeczytasz na stronie Warunki korzystania z API.

Po wysłaniu okno pokaże kod wniosku: sześć znaków, np. VQF 7G3. Ten sam kod widać w szczegółach integracji, dopóki wniosek czeka na decyzję.

Potwierdź wniosek kodem

Zespół Prynt zadzwoni lub napisze do drukarni i poda kod wniosku. Sprawdź, czy zgadza się z kodem w szczegółach integracji. Tak obie strony wiedzą, że rozmawiają o tym samym wniosku i że złożył go ktoś z drukarni. Jak rozpoznać prawdziwy kontakt od Prynt, przeczytasz w Jak rozpoznasz kontakt od Prynt.

O decyzji dostaniesz powiadomienie. Prynt może przyznać węższy zakres niż we wniosku. To, co przyznał, zobaczysz w sekcji Przyznany zakres. Wniosek, który jeszcze czeka na decyzję, wycofasz przyciskiem Wycofaj wniosek. Wycofany wniosek znika z listy, a jego kod przestaje obowiązywać.

Wygeneruj klucz

Klucz API działa jak hasło integracji. Program integracji podaje go przy każdym połączeniu z Prynt.

Otwórz integrację ze statusem Aktywna i kliknij Wygeneruj klucz.
W polu Nazwa klucza wpisz nazwę, np. miejsce, w którym klucz będzie używany.
Wybierz Ważność: 30, 90, 180 albo 365 dni.
W polu Twoje hasło wpisz hasło, którym logujesz się do Prynt, i kliknij Wygeneruj klucz.
Prynt pokaże klucz jeden raz. Kliknij Kopiuj i przekaż klucz programiście bezpiecznym kanałem, np. przez menedżer haseł. Nie wysyłaj go e-mailem ani komunikatorem.
Zaznacz Klucz jest zapisany w bezpiecznym miejscu i kliknij Gotowe.

Do tej chwili okna z kluczem nie zamkniesz kliknięciem obok, klawiszem Escape ani przesunięciem w dół na telefonie. Gdy spróbujesz wyjść ze strony, np. przyciskiem Wstecz albo gestem cofania na telefonie, Prynt zapyta Wyjść bez zapisania klucza?. Klucza nie da się później odczytać. Zgubiony klucz unieważnij i wygeneruj nowy.

Po kilku błędnych hasłach albo zbyt wielu próbach w krótkim czasie Prynt prosi, żeby odczekać minutę. Integracja może mieć ograniczoną liczbę działających kluczy. Gdy ją osiągniesz, Prynt to podpowie. Unieważnij wtedy klucz, którego nie używasz.

Rotuj klucz

Rotacja zastępuje klucz nowym bez przerwy w działaniu integracji, np. przed końcem ważności.

Kliknij Rotuj przy kluczu. Na telefonie znajdziesz tę opcję w menu ⋯ karty klucza.
W polu Stary klucz działa jeszcze przez wybierz 1 godzina, 1 dzień albo 7 dni.
Wpisz Twoje hasło i kliknij Rotuj klucz.
Zapisz nowy klucz tak samo jak przy generowaniu.

Nowy klucz ma tę samą długość ważności co stary (np. 180 dni), liczoną od dnia rotacji. Stary klucz ma status Wygasa po rotacji i działa do końca wybranego czasu. W tym czasie podmień klucz w integracji. Klucza opisanego jako Klucz Prynt nie rotujesz, bo wymienia go zespół Prynt.

Unieważnij klucz

Unieważnienie wyłącza klucz od razu i na zawsze. Użyj go, gdy klucz wyciekł albo nie jest już potrzebny.

Kliknij Unieważnij przy kluczu (na telefonie w menu ⋯).
Opcjonalnie wpisz Powód (opcjonalnie). Trafi do historii zmian.
Kliknij Unieważnij klucz.

Unieważnić możesz też klucz wydany przez Prynt. Zespół Prynt dostanie wtedy informację. Unieważnione i wygasłe klucze zobaczysz po kliknięciu Pokaż unieważnione i wygasłe.

Poproś o rozszerzenie zakresu

Gdy integracja ma robić więcej, poproś o dodatkowe zakresy.

W szczegółach integracji kliknij Poproś o rozszerzenie.
Zaznacz dodatkowe zakresy. Zakresy oznaczone Już przyznany albo Czeka na decyzję Prynt są zablokowane.
Kliknij Wyślij prośbę.

Prośba dostaje własny kod: Kod rozszerzenia. Potwierdzasz go tak samo jak wniosek. Do decyzji Prynt integracja działa w dotychczasowym zakresie. Po akceptacji istniejące klucze dostają nowy zakres, więc nie musisz generować nowego klucza.

Wstrzymaj i wznów integrację

Wstrzymaj zatrzymuje wszystkie klucze integracji, ale ich nie unieważnia. Przydaje się, gdy system integracji działa nieprawidłowo. Wznów przywraca działanie tych samych kluczy. Obie operacje wymagają potwierdzenia. Wznowienie nie przywróci integracji, którą zawiesił Prynt albo której akceptacja wygasła.

Archiwizuj integrację

Archiwizuj zamyka integrację na stałe. Wszystkie jej działające klucze zostają unieważnione, a integracja znika z listy. Zobaczysz ją po włączeniu Pokaż zarchiwizowane. Zarchiwizować możesz też odrzucony wniosek. Wniosku, który czeka na decyzję, nie archiwizujesz. Wycofujesz go przyciskiem Wycofaj wniosek.

Integracje prowadzone przez Prynt

Niektóre integracje prowadzi zespół Prynt, np. połączenie z poprzednim systemem drukarni. Na liście i w szczegółach mają znacznik Prowadzona przez Prynt. Ich klucze wydaje i wymienia zespół Prynt. Taką integrację możesz wstrzymać i wznowić (Wstrzymaj, Wznów), a przy podejrzeniu wycieku unieważnić jej klucz (Unieważnij). Zespół Prynt dostanie wtedy informację. Takich integracji nie archiwizujesz i nie rozszerzasz.

Zmiany wprowadzone przez integrację

Zmiany, które integracja wprowadza w danych drukarni, np. zamówienie ze sklepu, widać w historii tych danych. Autorem jest wtedy integracja, oznaczona plakietką Integracja.

Wszystkie zmiany jednej integracji zebrane w jednym miejscu zobaczysz w jej szczegółach, w sekcji Działania integracji. Dzięki temu sprawdzisz, co integracja faktycznie zrobiła, a nie tylko kiedy ostatnio użyła klucza (Ostatnie użycie przy kluczu).

Połączenie z poprzednim systemem drukarni zapisuje tam każdą przyjętą kalkulację (Utworzono) i każdą zmianę kalkulacji wysłanej ponownie (Zaktualizowano). Ponowne wysłanie bez zmian nie dodaje wpisu. Kalkulacje przyjęte, zanim pojawiła się ta sekcja, nie mają takich wpisów.

Aplikacje logujące pracowników

Pod listą integracji jest sekcja Aplikacje logujące pracowników. To aplikacje drukarni, do których pracownicy logują się swoim kontem Prynt, przyciskiem Zaloguj przez Prynt (jak to wygląda dla pracownika: Logowanie do aplikacji drukarni kontem Prynt). Aplikacja działa w imieniu zalogowanej osoby i z jej uprawnieniami, bez osobnego klucza. Taką aplikację rejestruje zespół Prynt — jeśli jej potrzebujesz, skontaktuj się z zespołem Prynt.

Lista ma kolumny Aplikacja, Stan, Ważna do i Zalogowane osoby. Stany:

Stan	Co znaczy
Aktywna	Pracownicy logują się i pracują w aplikacji.
Wstrzymana	Drukarnia wstrzymała aplikację: nikt się nie zaloguje, a zalogowani nie pracują do wznowienia.
Zawieszona przez Prynt	Zespół Prynt chwilowo wyłączył aplikację. Zalogowane osoby zostają, pracują dalej po odwieszeniu.
Wygasła	Minęła data ważności. Wszyscy zostali wylogowani. Przedłużenie: zespół Prynt.
Usunięta przez Prynt	Aplikacji już nie ma. Wszyscy zostali wylogowani, zostaje tylko jej historia.

Kliknij nazwę aplikacji, żeby otworzyć jej stronę. Zobaczysz tam:

Zalogowane osoby — kto jest teraz zalogowany (imię, nazwisko i login), na ilu urządzeniach, od kiedy (Zalogowana od) i kiedy ostatnio korzystał z aplikacji (Ostatnie użycie),
Szczegóły — Ważna do, Zarejestrowana, Adresy powrotu (adresy aplikacji, do których Prynt odsyła po logowaniu) i — przy wstrzymanej aplikacji — kto i kiedy ją wstrzymał. Adresy i ważność ustala zespół Prynt; zmienisz je tylko przez kontakt z zespołem,
Historię zmian aplikacji (dla osoby, która może przeglądać użytkowników).

Wyloguj osobę albo wszystkich

Przy osobie kliknij Wyloguj, a przy liście Wyloguj wszystkich. Po potwierdzeniu osoba (albo każda osoba) zostaje wylogowana z aplikacji na wszystkich urządzeniach. Może zalogować się ponownie, jeśli aplikacja nie jest wstrzymana. Przydaje się, gdy ktoś zostawił zalogowaną aplikację na cudzym komputerze albo gdy pracownik odchodzi.

Pracownik sam wyloguje się z aplikacji w Moje konto → Bezpieczeństwo → Połączone aplikacje. Dezaktywacja konta i zmiana hasła wylogowują go ze wszystkich aplikacji automatycznie.

Wstrzymaj i wznów aplikację

Wstrzymaj (z potwierdzeniem) od razu wyłącza aplikację: nikt się do niej nie zaloguje, a jej dostęp do danych drukarni zostaje odcięty. Zalogowani pracownicy nie są wylogowywani. Wznów przywraca działanie — zalogowane osoby pracują dalej, chyba że przez dobę nie korzystały z aplikacji (wtedy logują się ponownie). Wstrzymanie nie zdejmuje decyzji Prynt: wznowienie nie uruchomi aplikacji zawieszonej przez Prynt. Aplikacji, która wygasła albo została usunięta, nie wstrzymasz ani nie wznowisz — nikt się do niej już nie zaloguje, więc przycisków nie ma. O wstrzymaniu i wznowieniu zespół Prynt dostaje informację.

Historia aplikacji

Historia zmian aplikacji pokazuje decyzje zespołu Prynt (rejestrację, zmianę adresów i ważności, zawieszenie — oznaczone jako zmiany automatyczne), wstrzymanie i wznowienie przez drukarnię (z osobą, która to zrobiła) oraz wylogowania przez administratora (Zakończone logowania w aplikacjach, a przy jednej osobie jej login). Logowanie i wylogowanie konkretnej osoby widać też w historii jej konta.

Na telefonie

Lista integracji, lista kluczy, lista aplikacji i lista zalogowanych osób są kartami. Akcje klucza (Rotuj, Unieważnij) są w menu ⋯ na karcie, a Wyloguj przy osobie zalogowanej do aplikacji — na jej karcie. Okno z nowym kluczem zamkniesz dopiero po zaznaczeniu Klucz jest zapisany w bezpiecznym miejscu (wystarczy dotknąć dowolnego miejsca tej karty). Nie zamknie go przesunięcie w dół ani przycisk ×, a gest cofania najpierw zapyta, czy na pewno chcesz wyjść.

Dla programisty

Programista, który buduje integrację, znajdzie opis API, przykłady i referencję w sekcji Dla programistów. W aplikacji prowadzi do niej przycisk Dokumentacja dla programistów na liście integracji. Link możesz wysłać zwykłą wiadomością, ale sam klucz przekaż osobno, bezpiecznym kanałem.

Programiście przydadzą się zwłaszcza dwie strony:

Dostęp i akceptacja: wniosek, decyzja Prynt i klucze opisane od jego strony,
Szybki start: pierwsze połączenie z Prynt kluczem, który mu przekażesz.

Powiązane

Bezpieczeństwo: role i uprawnienia, w tym zarządzanie ustawieniami systemu.
Konfiguracja: pozostałe grupy ustawień.