Przegląd otwartego API

Przegląd

PlanRadar zapewnia bezpieczne interfejsy API REST, które są otwarte dla wszystkich klientów w celu ich własnej integracji.
Ponadto PlanRadar zapewnia również PlanRadar Connect do tworzenia niestandardowych automatyzacji i integracji z aplikacjami innych firm bez kodowania. Więcej informacji znajdą Państwo na stronie PlanRadar Connect.

Interfejs API REST zawiera adresy URL zorientowane na zasoby, akceptuje treści żądań zakodowane w formularzach, zwraca odpowiedzi zakodowane w formacie JSON i wykorzystuje standardowe kody odpowiedzi HTTP oraz uwierzytelnianie.

Dostęp i uprawnienia

Korzystanie z otwartych interfejsów API

Podczas korzystania z interfejsów API mogą Państwo wysłać do 30 żądań na minutę. Przekroczenie tego limitu spowoduje wyłączenie Państwa tokena autoryzacyjnego na 5 minut. W przypadku specjalnych wymagań prosimy skontaktować się z naszym zespołem wsparcia.

Autoryzacja dostępu do API

Podczas korzystania z interfejsu API należy dodać klucz autoryzacji jako wartość nagłówka "X-PlanRadar-API-Key". Klucz autoryzacji można uzyskać, generując Personal Access Tokens i używając ich do uwierzytelniania żądań API.

Dostępne interfejsy API

1. Proszę kliknąć Ustawienia
2. Proszę kliknąć Dokumentacja API
3. Proszę wprowadzić hasło
4. Proszę kliknąć Potwierdź
   

   

5. Proszę wybrać funkcję ****, której interfejsy API mają zostać wyświetlone
   

   

6. Pojawi się lista wszystkich interfejsów API związanych z tą funkcją
   

   

Przykładowe żądanie API

Oto przykład wykorzystania interfejsów API do wywoływania szczegółów projektu:

API URL:

GET /api/v1/{customer_id}/projects

Treść żądania:

  {
    "data": {
      "attributes": {
        "name": "Your Project Name"
      }
    }
  }

Treść odpowiedzi:

  {
    "data": {
      "id": "aqbqod",
      "type": "projects",
      "attributes": {
        "id": "aqbqod",
        "name": "Your Project Name",
        "homepage": "",
        "country": null,
        "projectnumber": null,
        "description": null,
        "city": null,
        "zipcode": null,
        "street": null,
        "author-id": "pxpp",
        ...
      }
    }
  }

Podstawowe koncepcje API

Proszę zapoznać się z podstawowymi koncepcjami naszych interfejsów API. Więcej informacji znajdą Państwo na stronie Core API Concepts.

Samouczki API

Proszę zapoznać się z samouczkami krok po kroku dotyczącymi korzystania z naszych interfejsów API w następujących obszarach:

Samouczki API dla punktów końcowych użytkownika

Samouczki API dla punktów końcowych projektu

Samouczki API dla punktów końcowych Zadania

Samouczki API dla punktów końcowych dokumentów

Samouczki API dla punktów końcowych harmonogramu

Dziennik zmian API

Prosimy zapoznać się z najnowszymi aktualizacjami i zmianami w naszych interfejsach API. Więcej informacji znajdą Państwo w API Changelog.