URL Shortener API: Automate Short Links in Your App

Tworzenie linków ręcznie jest w porządku, dopóki nie przestaje być. W momencie, gdy każde zamówienie potrzebuje linku śledzenia, każdy użytkownik potrzebuje linku polecającego, lub każda lista potrzebuje kodu QR, potrzebujesz tego samego programowo. To jest to, do czego służy API skracacza URL — i to jest na tyle mała powierzchnia, że możesz to podłączyć przy kawie.

Co możesz zautomatyzować

• Linki na zamówienie lub na użytkownika generowane w momencie, gdy są potrzebne.
• Linki kampanii zbiorczych — jeden na kanał, tworzony z arkusza kalkulacyjnego w pętli zamiast ręcznie.
• Kody QR na bieżąco dla biletów, faktur, etykiet i listów przewozowych.
• Kliknij dane pobrane do swojego własnego pulpitu nawigacyjnego, aby liczby były tam, gdzie już patrzy twój zespół.

Jeśli nie jesteś pewien, czy potrzebujesz API, uczciwym testem jest wolumen i powtarzalność: jeśli robisz to samo w przeglądarce więcej niż kilka razy w tygodniu, zautomatyzuj to.

Uwierzytelnij

Pobierz swój klucz z strony swojego konta i wyślij go jako X-Api-Key nagłówek w każdym żądaniu. Dwie zasady, które nie podlegają negocjacjom: trzymaj klucz po stronie serwera — wszystko, co jest w JavaScript po stronie klienta, jest publiczne, a wyciekły klucz pozwala obcym tworzyć linki w twoim imieniu — i natychmiast go zmień, jeśli kiedykolwiek trafi do repozytorium lub logu.

Utwórz link

Jedno POST do /api/getLink.json z docelowym adresem. Możesz przekazać alias, tryb, datę wygaśnięcia i hasło w tym samym wywołaniu:

curl -X POST https://urlik.app/api/getLink.json -H "X-Api-Key: YOUR_KEY" -d "url=https://example.com/very/long/path" -d "alias=spring-sale"

Odpowiedź to JSON zawierający krótki URL, jego URL QR i URL statystyk. Linki utworzone za pomocą klucza są przypisane do twojego konta, więc pojawiają się na twoim pulpicie i mogą być edytowane później.

Warto wiedzieć przed rozpoczęciem budowy: alias jest unikalny w całej usłudze. Jeśli spring-sale jest zajęty, otrzymasz błąd, a nie cichą alternatywę — więc albo obsłuż ten przypadek, albo nadaj swoim aliasom przestrzeń nazw (acme-spring-sale).

Generuj kod QR

GET /api/qr.json przyjmuje dane plus opcjonalne format, fg, bg, ecc i size, i zwraca QR. Wskazuj go na krótki link zamiast surowego długiego URL — otrzymasz czystszy, bardziej wytrzymały kod, a docelowy adres pozostanie edytowalny później. To jest dynamiczny kod QRwzór, wykonany z twojego zaplecza.

Przeczytaj statystyki

GET /api/stats.jsonzwraca sumy, szereg czasowy, odnośniki, urządzenia i kraje dla linku — te same liczby co strona statystyk, w formie, którą możesz umieścić w swoim własnym panelu administracyjnym.

Pytaj o to w ustalonym harmonogramie, a nie przy każdym załadowaniu strony. Kliknięcia statystyk nie są systemem rejestracji w czasie rzeczywistym, a bombardowanie punktu końcowego w celu narysowania wykresu, którego nikt nie ogląda, to sposób na osiągnięcie limitu szybkości.

Zbuduj to tak, aby nie psuło się o 3 nad ranem

Punkty końcowe są proste; integracje, które zawodzą, to te, które zakładają, że nic nigdy nie idzie źle. Cztery nawyki, które się opłacają:

• Zawsze sprawdzaj odpowiedź.Każde wywołanie zwraca status — przeczytaj go. Klasycznym błędem jest zakładanie sukcesu i przechowywanie ciała błędu tak, jakby to był krótki link, a następnie odkrycie go na wydrukowanej fakturze.
• Nigdy nie blokuj użytkownika na linku.Jeśli skracanie odbywa się w trakcie realizacji zamówienia, wolne API staje się wolnym procesem realizacji zamówienia. Zrób to w tle lub wróć do długiego URL i spróbuj ponownie później. Długi URL zawsze działa; to jest twoja siatka bezpieczeństwa.
• Cache'uj to, co się nie zmienia.Ten sam cel nie potrzebuje skracania dwa razy — przechowuj krótki URL w rekordzie źródłowym i używaj go ponownie. Tańsze, szybsze, a twój pulpit nawigacyjny pozostaje czytelny.
• Wycofaj się w przypadku błędów.Spróbuj ponownie z wydłużającymi się opóźnieniami, a nie w ciasnej pętli. Ograniczenie szybkości odpowiedziane burzą prób ponownych pozostaje ograniczeniem szybkości.

Gdzie API się zatrzymuje

Dwa uczciwe limity. Limity szybkości istnieją, a hojne nie są nieskończone — zadania wsadowe powinny być rozłożone w czasie, a nie uruchamiane wszystkie naraz. A API tworzy linki; nie decyduje, co powinno się w nich znajdować. Oznaczaj swoje linki parametrami UTM w momencie tworzenia (zobacz przewodnik UTM) lub zautomatyzujesz produkcję tysięcy linków, których nie będziesz w stanie odróżnić w analizach — co jest gorszą sytuacją niż robienie tego ręcznie.

Krótka wersja

Jeden punkt końcowy do tworzenia, jeden do QR, jeden do statystyk, nagłówek do autoryzacji. Trzymaj klucz po stronie serwera, sprawdzaj każdą odpowiedź, wykonuj pracę poza krytyczną ścieżką, buforuj to, co się powtarza i taguj podczas tworzenia. Pełna lista parametrów, kody błędów i przykłady znajdują się w dokumentacji API; jeśli chcesz najpierw poznać tło koncepcyjne, zacznij od tym, czym jest skracacz URL.