Przejdź do głównej zawartości

Dostęp i akceptacja

Dla: Programista

Dostęp do API ma zawsze konkretna integracja jednej drukarni. Wniosek składa administrator drukarni, decyzję podejmuje Prynt, a klucz wydaje administrator po akceptacji. Programista integracji nie potrzebuje konta w Prynt: dostaje klucz od drukarni.

  1. Administrator drukarni otwiera Konfiguracja → Integracje → Integracje API i klika Złóż wniosek.

  2. Wypełnia pola Nazwa integracji (pod tą nazwą integracja będzie autorem zmian w Prynt, np. „Sklep internetowy”), Do czego służy i Kontakt techniczny (zwykle Ty albo Twoja firma), a w sekcji Zakres danych zaznacza potrzebne zakresy.

  3. Akceptuje Warunki korzystania z API. Przy zakresach z danymi osobowymi akceptacja obejmuje też zasady dotyczące danych osobowych (punkt 4 warunków): drukarnia potwierdza, że ma podstawę, by przekazać Ci dane klientów i osób kontaktowych. Klika Wyślij wniosek.

  4. Wniosek dostaje status Oczekuje na decyzję Prynt i sześcioznakowy kod wniosku.

  • Kto wnioskuje. Zespół Prynt dzwoni albo pisze do drukarni i podaje kod wniosku. Drukarnia sprawdza, czy zgadza się z kodem przy wniosku w aplikacji. Tak obie strony wiedzą, że rozmawiają o tym samym wniosku i że złożył go ktoś z drukarni.
  • Cel i zakresy. Czy zakresy pasują do celu integracji. Prynt może zatwierdzić węższy zestaw zakresów niż we wniosku.
  • Dane osobowe. Czy integracja z zakresami obejmującymi dane osób ma podstawę do ich przetwarzania.
  • Kontakt techniczny. Do kogo napiszemy, gdy integracja zachowuje się nieprawidłowo.

Osoba, która złożyła wniosek, dostaje powiadomienie o decyzji, a integracja zmienia status na Aktywna albo Odrzucona. Zatwierdzone zakresy administrator widzi w szczegółach integracji jako Przyznany zakres. Po akceptacji:

  1. Administrator otwiera integrację i klika Wygeneruj klucz. Wpisuje nazwę w polu Nazwa klucza, wybiera Ważność (30, 90, 180 albo 365 dni) i potwierdza operację hasłem w polu Twoje hasło.

  2. Prynt pokazuje klucz jeden raz. Administrator kopiuje go, zaznacza Klucz jest zapisany w bezpiecznym miejscu, klika Gotowe i przekazuje Ci klucz bezpiecznym kanałem, np. przez menedżer haseł z udostępnianiem. Nie przez e-mail ani komunikator.

  3. Od tej chwili klucz działa w API. Zacznij od Szybkiego startu.

  • Rotacja. Administrator klika Rotuj przy kluczu. Nowy klucz działa od razu, a stary jeszcze przez wybrany czas (1 godzinę, 1 dzień albo 7 dni), więc przełączysz integrację bez przerwy. Szczegóły: Rotacja klucza.
  • Unieważnienie. Unieważnij wyłącza klucz natychmiast i na zawsze. Używa się go po wycieku albo gdy klucz nie jest już potrzebny.
  • Wstrzymanie. Wstrzymaj zatrzymuje całą integrację bez unieważniania kluczy, np. na czas awarii po Twojej stronie. Wznów przywraca działanie tych samych kluczy.
  • Nowe zakresy. Gdy integracja ma robić więcej, administrator klika Poproś o rozszerzenie. Rozszerzenie przechodzi taką samą akceptację jak wniosek, z własnym kodem; do tego czasu integracja działa w dotychczasowym zakresie. Po akceptacji istniejące klucze od razu dostają nowe zakresy: nowy klucz nie jest potrzebny.

Integracja, której akceptacja wygasła albo została cofnięta, dostaje błąd API_INTEGRATION_NOT_APPROVED, a wstrzymana przez drukarnię albo zawieszona przez Prynt API_INTEGRATION_SUSPENDED. Klucz po dacie ważności dostaje API_TOKEN_EXPIRED. W każdym z tych przypadków skontaktuj się z administratorem drukarni. Wszystkie kody: Błędy.