Zgodność z API Toggl

OpenTickly mówi tym samym API co Toggl. Skrypty, CLI i agenci napisani dla Toggl mogą rozmawiać z Twoją instancją OpenTickly, gdy zmienisz im adres i token. Trzymamy się trzech API Toggl: Track v9, Reports v3 i Webhooks v1.

Adresy bazoweCopy Anchor Link

Zamień https://twoja-instancja.example na publiczny adres swojego serwera OpenTickly.

Jeśli klienci łączą się z instancją przez internet, postaw ją za HTTPS. Sam kontener Dockera obsługuje tylko zwykły HTTP, więc HTTPS zwykle zapewnia reverse proxy, np. Nginx albo Caddy.

Zdobądź token APICopy Anchor Link

Zaloguj się do aplikacji webowej OpenTickly, otwórz menu pod awatarem, wybierz Profil i znajdź API Token. Traktuj token jak hasło: nie commituj go do gita, nie wklejaj do zgłoszeń i nie wypisuj w logach.

Logowanie działa tak samo jak w Toggl: HTTP Basic auth, gdzie token jest nazwą użytkownika, a hasłem jest dosłownie tekst api_token:

curl --user "${OPENTICKLY_API_TOKEN}:api_token" \
  https://twoja-instancja.example/api/v9/me

Najpierw ustaw OPENTICKLY_API_TOKEN w powłoce. Jeśli dostaniesz z powrotem dane swojego konta, token działa.

Przełącz istniejące narzędzie na OpenTicklyCopy Anchor Link

Większość narzędzi wymaga tylko dwóch zmian:

1. Zamień adres API Toggl na adres OpenTickly z tabeli powyżej.
2. Użyj tokenu API z OpenTickly zamiast tokenu z Toggl.

Dla toggl-cli:

toggl auth <YOUR_API_TOKEN> \
  --api-type opentoggl \
  --api-url https://twoja-instancja.example/api/v9

Jeśli zewnętrzna aplikacja ma adres Toggl wpisany na sztywno i nie da się go zmienić w ustawieniach, nie przełączysz jej na OpenTickly.

Sprawdź przed przejściemCopy Anchor Link

Testuj te zapytania, które Twoje narzędzie faktycznie wysyła, a nie całe API. Zanim zaczniesz na nim polegać:

1. Pobierz dane bieżącego użytkownika przez GET /api/v9/me.
2. Wylistuj obszar roboczy, projekty, tagi i ostatnie wpisy czasu.
3. Utwórz i zatrzymaj testowy wpis czasu.
4. Uruchom to samo zapytanie o raport, którego używa Twój skrypt.
5. Jeśli korzystasz z webhooków, utwórz testową subskrypcję, a potem ją usuń.
6. Sprawdź obsługę błędów, stronicowanie, daty i strefy czasowe.

Nie każdy endpoint Toggl działa jeszcze identycznie. Jeśli coś działa w Toggl, a w OpenTickly nie, zgłoś to w GitHub Issues, dołączając zapytanie i odpowiedź, którą dostałeś.

W skryptach działających samodzielnie nie wpisuj adresu ani tokenu do kodu, używaj konta, które ma dostęp tylko do potrzebnych obszarów roboczych, i wygeneruj nowy token, jeśli stary wycieknie.