Wprowadzenie do REST API

Z Planfix

Dostęp do API jest możliwy tylko dla kont płatnych lub premium.

Aby rozpocząć pracę, wygeneruj token autoryzacyjny. Można to zrobić przez głównego administratora konta w sekcji: Zarządzanie kontem — Dostęp do API — REST API.

Dostęp do interfejsu

  • Dostęp do interfejsu zapewniany jest przez punkt wejścia, którego adres dostępny jest w sekcji REST API:
    • https://your_account_name.planfix.сom/rest/
  • Dostępny jest również link do specyfikacji REST oraz piaskownica (sandbox) do debugowania żądań względem Twojego konta.
  • Żądania wysyłane ze strony specyfikacji API są wykonywane bezpośrednio na Twoim koncie, a nie na danych testowych.

Uwaga

Dostęp do interfejsu realizowany jest przez protokół HTTPS. Wszystkie żądania wysyłane przez niezabezpieczone połączenie będą automatycznie ignorowane. Zalecamy skonfigurowanie bezpiecznego testowego połączenia z punktem dostępu interfejsu Planfix przed wysłaniem danych.

Limity żądań aplikacji

  • Wszystkie konta mają limit zależny od pakietu płatnego:
    • 20 000 / 50 000 / 100 000 żądań na dzień
    • 1 żądanie na sekundę
  • Dla metod zwracających listy wartości ustawiono limit 100 wyników na żądanie.
  • Przybliżona liczba pozostałych żądań na dzień zwracana jest w nagłówku X-RateLimit-Remaining — wartość ta jest aktualizowana mniej więcej co 10 minut.


Przejdź do