Dokumentacja dla Developera

⌘K
  2. Home
  4. Docs
  6. Dokumentacja dla Develope...
  8. API
  10. Dokumentacja Programisty TrackSystem

Dokumentacja Programisty TrackSystem

Pierwsze kroki z TrackSystem API

TrackSystem jest kompleksową platformą telematyczną GPS/pojazdu opracowaną przez SquareGPS Niniejsza dokumentacja zawiera szczegółowe informacje na temat integracji rozwiązań stron trzecich z platformą TrackSystem, w tym API oraz dokumentację techniczną dostosowaną do potrzeb programistów i partnerów.

Jak korzystać z tej dokumentacji

Dokumentacja podzielona jest na sekcje, z których każda dotyczy konkretnego aspektu platformy TrackSystem:

  • Ogólny: Wprowadzenie, TrackSystem API Sandbox, automatyzacja bez kodu i wytyczne dotyczące wkładu.
  • API platformy TrackSystem: API wymaga funkcjonalności interfejsu użytkownika, takich jak surowe dane urządzenia, śledzenie, raporty, zadania i wiele innych.
  • Interfejs API panelu administracyjnego: API wymaga funkcjonalności panelu administracyjnego, takich jak konfiguracja platformy i zarządzanie użytkownikami.

Przejdź do sekcji dokumentacji za pomocą lewego paska bocznego. Użyj wewnętrznego menu po prawej stronie, aby szybko poruszać się po stronie.

Dostęp do powiązanego repozytorium GitHub można uzyskać bezpośrednio poprzez link na lewym pasku bocznym.

Struktura dokumentacji

Dokumentacja zawiera dwa typy plików: Dokumenty i wywołania API. Dokumenty podzielone są na części semantyczne, zaczynając od wstępu podsumowującego treść.

Opisy wywołań API

Zasoby sekcje reprezentują odniesienie API dla powiązanej funkcjonalności i mają wspólną strukturę:

  • Wprowadzenie – Ogólne informacje i cel wywołania API.
  • Struktura obiektu – Opisuje strukturę obiektów używaną w wywołaniach (opcjonalnie).
  • Akcje API – Podstawowe wywołanie API i powiązane działania, w tym:
    • Opis akcji – Cel akcji API.
    • Wymagania – Niezbędne uprawnienia (opcjonalne).
    • Tabela parametrów – Wyświetla parametry wywołania API wraz z opisami i typami danych.
    • Przykłady – Przykłady wywołań API z parametrami. Zawiera przycisk kopiowania ułatwiający korzystanie.
    • Odpowiedź – Przykład udanej odpowiedzi serwera z opisami pól.
    • Błędy – Konkretne błędy związane z akcją API oraz ogólna lista błędów.

Limity API

Aby zapewnić stabilność systemu dla wszystkich klientów, platforma ogranicza liczbę żądań API do 50 żądań na sekundę na użytkownika i adres IP (w przypadku aplikacji obsługujących wielu użytkowników). Limity te są stosowane w oparciu o skrót sesji użytkownika i klucze API.

TrackSystem udostępnia potężną kolekcję Postman, TrackSystem API Sandbox, do pracy z dokumentacją API, eksploracji i testowania zapytań API przy użyciu danych rzeczywistych lub demonstracyjnych. Kolekcja ta oferuje znane środowisko dla wielu programistów i upraszcza proces tworzenia dostosowanych rozwiązań. Szczegółowe informacje na temat korzystania z Postmana z TrackSystem można znaleźć w Przewodnik po listonoszach.

Zaangażuj się

Pomóż ulepszyć Dokumentacja programisty Navixy lub pomóc tłumaczenia językowe. Twój wkład sprawia, że platforma TrackSystem jest jeszcze lepsza dla społeczności.