Przegląd
PlanRadar zapewnia bezpieczne interfejsy API REST, które są otwarte dla wszystkich klientów w celu ich własnej integracji. Co więcej, PlanRadar zapewnia również PlanRadar Connect do tworzenia niestandardowych automatyzacji i integracji z aplikacjami innych firm bez konieczności 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
Otwarte interfejsy API są dostępne tylko dla kont Pro i Enterprise. Więcej informacji znajdą Państwo na stronie Cennik i subskrypcja.
Aby korzystać z otwartych interfejsów API, potrzebują Państwo użytkownika wewnętrznego z uprawnieniem "API Access". Więcej informacji znajdą Państwo na stronie 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
- Proszę kliknąć Ustawienia
- Proszę kliknąć Dokumentacja API
- Proszę wprowadzić hasło
- Proszę kliknąć Potwierdź
- Proszę wybrać funkcję , której interfejsy API mają zostać wyświetlone
- Pojawi się lista wszystkich interfejsów API związanych z tą funkcją
Obecnie pracujemy nad aktualizacją wszystkich naszych interfejsów API do wersji v2. Zalecamy korzystanie z interfejsów API v2, jeśli są one dostępne. Interfejsy API v2 są szybsze, solidniejsze i bardziej elastyczne niż interfejsy API v1.
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": "Nazwa Państwa projektu"
}
}
}
Treść odpowiedzi:
{
"data": {
"id": "aqbqod",
"type": "projects",
"attributes": {
"id": "aqbqod",
"name": "Nazwa Pana/Pani projektu",
"strona główna": "",
"country": null,
"projectnumber": null,
"description": null,
"city": null,
"zipcode": null,
"street": null,
"author-id": "pxpp",
...
}
}
}
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.