Get Tools Lab Programowanie API

Opcje API

Platforma zawiera punkty końcowe REST i lekką warstwę kompatybilną z GraphQL, z obsługą kluczy API, poświadczeń klienta OAuth, analizą użycia, limitami szybkości i dostarczaniem podpisanego webhooka. Nie każda funkcja publicznej witryny internetowej jest automatycznie dostępna za pośrednictwem interfejsu API.

Uwierzytelnianie

Punkty końcowe REST v1 mogą używać klucza API w pliku Nagłówek X-API-Key . Nowsze punkty końcowe mogą również akceptować obsługiwane tokeny okaziciela. Zachowaj wszystkie dane uwierzytelniające w tajemnicy i natychmiast obróć klucz, jeśli zostanie ujawniony.

curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"

Typowe punkty końcowe REST

narzędzia diagnostyczne

GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json

Poradniki

GET /api/v1/guides.php
GET /api/v1/guides.php?q=image

REST v2 i GraphQL

Skonsolidowana platforma programistyczna może udostępniać nowsze trasy REST i operacje GraphQL dla obsługiwanych zasobów. Użyj obszaru Programowanie i placu zabaw API, aby zobaczyć punkty końcowe, które są faktycznie włączone w bieżącym wdrożeniu.

Limity szybkości

Żądania API mogą być ograniczone minutowo lub dziennie. Żądanie przekraczające limit może zwrócić HTTP 429 Too Many Requests wraz z informacją o ponownej próbie lub zresetowaniu. Aplikacje powinny używać wycofywania zamiast natychmiastowego powtarzania nieudanych żądań.

Haki internetowe

Obsługiwane zdarzenia mogą być dostarczane do miejsca docelowego webhooka HTTPS. Jeśli podpisywanie jest włączone, przed zaufaniem ładunku sprawdź podpis HMAC. Konsument webhooka powinien również tolerować ponowne próby i powinien sprawić, że przetwarzanie zdarzeń będzie idempotentne, aby to samo dostarczenie nie powodowało duplikowania działań.

Błędy

Nieprawidłowe poświadczenia, wyłączeni klienci, wyczerpane przydziały lub źle sformułowane żądania mogą zwracać błędy strukturalnego JSON z kodami stanu HTTP 4xx. Awarie po stronie serwera korzystają z odpowiedzi 5xx. Aplikacje powinny rejestrować status odpowiedzi i identyfikator żądania, jeśli jest dostępny, zamiast ujawniać tajne poświadczenia w raportach o błędach.

Bezpieczeństwo guidance

• Nigdy nie osadzaj tajnych kluczy API w JavaScript przeglądarki publicznej.
• Użyj protokołu HTTPS dla ruchu API i elementu webhook.
• Daj klientom tylko te uprawnienia, których potrzebują.
• Sprawdź poprawność podpisów webhooka.
• Zmień skompromitowane dane uwierzytelniające.
• Przestrzegaj udokumentowanych limitów szybkości i rozmiaru pliku.

SDK i plac zabaw

Odwiedź sekcję Programowanie, aby zapoznać się z przykładami SDK i interaktywnym placem zabaw. Przetestuj integracje z niewrażliwymi danymi przed użyciem plików produkcyjnych lub informacji o klientach.