Baza Wiedzy – Integracja oprogramowania przez API

 

Ten artykuł obejmuje następujące zagadnienia:

  1. Interaktywna dokumentacja API
  2. Zarządzanie tokenami dostępu osobistego
  3. Zarządzanie Webhookami na koncie
  4. Przyznawanie uprawnień dostępu do funkcji API

 

Integracja oprogramowania przez API

PlanRadar oferuje web API (Interfejs Programowania Aplikacji) i Webhooki, umożliwiające integrację wyprodukowanego przez inne firmy lub na własne potrzeby oprogramowania z kontem PlanRadar.

Korzystanie z API wymaga wiedzy z zakresu tworzenia oprogramowania. Zalecamy uzyskanie dostępu i przygotowanie API we współpracy z zespołem rozwoju oprogramowania. Niestety PlanRadar nie jest w stanie zapewnić usług z zakresu tworzenia spersonalizowanego oprogramowania na rzecz naszych klientów.

 

Interaktywna dokumentacja API

Przed przystąpieniem do kolejnych kroków upewnij się, że posiadasz uprawnienia dostępu do funkcji API. Aby uzyskać dostęp do dokumentacji API, wejdź w Ustawienia > Dokumentacja API:

 

Masz możliwość bezpośredniego wypróbowania wszystkich naszych punktów końcowych (ang. endpoints). Niektóre z nich wymagają sprecyzowania ID projektu lub ID zadania, które zwykle znajdują się w adresie URL podglądu konkretnego projektu lub zadania, skąd można je skopiować.

Możesz również skopiować i wkleić komendy curl i wypróbować API z wiersza poleceń. Do tego potrzebny jest token dostępowy, który zostanie omówiony w następnej sekcji.

 

Zarządzanie tokenami dostępu osobistego

Korzystaj z tokenów dostępu osobistego, by umożliwić uwierzytelnienie oprogramowania zewnętrznego z naszymi serwerami podczas korzystania z API.

Przed przystąpieniem do kolejnych kroków upewnij się, że posiadasz uprawnienia dostępu do funkcji API. Tokeny dostępu osobistego można tworzyć i edytować w menu: Ustawienia > Profil > Token dostępu osobistego.

 

Tokeny są przyznawane na użytkownika. Nie powinno się ich udostępniać i należy się z nimi obchodzić ostrożnie. Każda osoba posiadająca Twój token dostępu może potencjalnie wejść na Twoje konto i działać w Twoim imieniu.

 

Maksymalny domyślny limit żądań to 30 na minutę. Na prośbę limit ten może zostać zwiększony – w takim przypadku prosimy o kontakt pod adresem [email protected].
 

Zarządzanie Webhookami na koncie

Webhooki umożliwiają oprogramowaniu zewnętrznemu reagowanie na zdarzenia w obrębie PlanRadar, np. „utworzono zadanie”, „zaktualizowano zadanie”, „załączono zdjęcie”, itp. Webhooki można tworzyć i edytować w menu: Ustawienia > Konto > Webhooki.

To ustawienie dostępne jest tylko dla właścicieli konta.

 

Kliknij „Dodaj nowy Webhook”. W tym miejscu możesz zdecydować, o jakich wydarzeniach ma być powiadamiane oprogramowanie zewnętrzne.

 

Uwierzytelnianie:
Tutaj możesz skonfigurować uwierzytelnianie ze swoim serwerem. Aktualnie obsługujemy „podstawowe uwierzytelnianie HTTP” nazwą użytkownika i hasłem.

 

Nagłówki:
Jeśli potrzebujesz dodatkowych pól nagłówka w swojej usłudze, możesz skonfigurować je tutaj. Hasła i inne poufne informacje mogą być prezentowane w formie ukrytych danych w interfejsie użytkownika. Jeśli zdecydujesz się na ich ukrycie, ze względów bezpieczeństwa nie będziesz mieć możliwości przywołania ich w interfejsie użytkownika po zapisaniu Webhooka.

 

Przyznawanie uprawnień dostępu do funkcji API

Do dokumentacji API i tokenów dostępu osobistego można uzyskać dostęp tylko z odpowiednimi uprawnieniami klienta. Właściciele konta zyskują automatyczny dostęp do dokumentacji API.

Aby inni użytkownicy wewnętrzni uzyskali odpowiednie uprawnienia, przejdź do menu: Zarządzanie użytkownikami > Użytkownicy. Tam edytuj lub stwórz nowego użytkownika wewnętrznego i zaznacz uprawnienie „Dostęp do API”.

 

Anulowanie tokenów dostępu innym użytkownikom

Masz możliwość wycofania tokenów dostępu utworzonych przez innych użytkowników wewnętrznych. Aby usunąć tokeny dostępu, potrzebujesz uprawnienia do zarządzania użytkownikami.

Aby usunąć token dostępu utworzony przez użytkownika, przejdź do: Zarządzanie użytkownikami > Użytkownicy w menu paska nawigacji. Tam wybierz użytkownika wewnętrznego, którego token chcesz usunąć z systemu. Tokeny utworzone przez użytkowników wyświetlają się po prawej stronie. W tym miejscu możesz je usunąć.

 

Uwaga: Tokeny dostępu utworzone przez właściciela konta nie mogą zostać usunięte przez innych użytkowników. Tylko właściciel konta może usunąć własne tokeny dostępu. Można to zrobić w menu: Ustawienia > Profil > Token dostępu osobistego.

Powrót do spisu treści.