REST API JSON do statystyk, recenzji, ocen i telefonów

Dane za Astriną — analizy strony, recenzje, podsumowania ocen i informacje o telefonach — są teraz dostępne do pobrania bezpośrednio do twojego kodu. API dla deweloperów to REST JSON API, które zwraca wszystko z jednego klucza.

Jeden klucz, cztery punkty końcowe

API jest wersjonowane pod /api/v1 i każdy punkt końcowy komunikuje się w prostym JSON. Wskaź swój klient na zasób, którego potrzebujesz:

• GET /api/v1/stats — analizy dla strony, którą posiadasz: odwiedzający, wyświetlenia stron, najpopularniejsze strony, źródła i kraje.
• GET /api/v1/reviews — recenzje oraz ocena dla tematu.
• GET /api/v1/rating — podsumowanie oceny z rozkładem gwiazdek.
• GET /api/v1/phone — informacje o telefonach.

Oprócz tego, API Auth obsługuje "Zaloguj się z Astriną", abyś mógł dodać logowanie przez media społecznościowe do swojej aplikacji bez budowania własnej struktury tożsamości.

Uwierzytelniaj w sposób, który pasuje do twojej struktury

Pobierz klucz z /my/api.php, a następnie wyślij go w najczystszy sposób dla twojego klienta. API akceptuje trzy formy:

• Token X-Api-Key nagłówek.
• Token Authorization: Bearer token.
• Token ?api_key= parametr zapytania.

Autoryzacja oparta na nagłówkach jest najbezpieczniejszym domyślnym rozwiązaniem dla kodu po stronie serwera; parametr zapytania jest przydatny do szybkich testów i wywołań po stronie przeglądarki. Odpowiedzi są otwarte na CORS, więc możesz wywołać API bezpośrednio z front-endu, gdy ci to odpowiada, a są oznaczone noindex aby twoje dane nie wyciekały do wyszukiwarek.

Limity i plany

Użycie jest mierzone dziennie, a każda odpowiedź informuje cię, na jakiej jesteś pozycji — każdy ładunek zawiera informacje o wykorzystaniu twojego limitu, więc nigdy nie musisz zgadywać, ile wywołań ci pozostało.

• Darmowy poziom: 100 wywołań dziennie.
• Plan API: 10 000 wywołań dziennie za €19 na 30 dni.
• Poziom analityki biznesowej:Dostęp do API jest wliczony.

Zacznij od wersji darmowej, aby stworzyć prototyp, a następnie przejdź na wyższą wersję, gdy Twoje potrzeby integracyjne będą wymagały więcej miejsca.

Przewidywalny JSON, przewidywalne błędy

Sukces i porażka wracają jako JSON. Gdy coś pójdzie nie tak, odpowiedź zawiera error pole i odpowiedni status HTTP, aby obsługa błędów mogła się rozgałęziać w zależności od kodu statusu zamiast analizować ciągi:

• 401 — przekroczono limit.
• 429 — złe parametry.
• 400 / 422Ponieważ stan limitu jest przesyłany w każdej odpowiedzi, dobrze zachowujący się klient może się wycofać, zanim w ogóle zobaczy 429.

Ponieważ stan kwoty jest wysyłany w każdej odpowiedzi, dobrze zachowujący się klient może się wycofać, zanim w ogóle zobaczy 429.

Jak zacząć

1. Otwórz /my/api.php i utwórz klucz API.
2. Wybierz punkt końcowy — zacznij od /api/v1/stats dla strony, którą posiadasz.
3. Wyślij swój klucz w nagłówku X-Api-Key i odczytaj JSON z powrotem.

Pierwsze wywołanie to jedna linia:

curl -H "X-Api-Key: YOUR_KEY" https://astrina.io/api/v1/stats

Wolisz token nośnika? Zmień nagłówek:

curl -H "Authorization: Bearer YOUR_KEY" https://astrina.io/api/v1/reviews

Lub wrzuć klucz bezpośrednio do URL, aby szybko sprawdzić:

curl "https://astrina.io/api/v1/rating?api_key=YOUR_KEY"

Stamtąd ten sam wzór obejmuje oceny i inteligencję telefoniczną — jeden klucz, jeden nagłówek, cztery źródła danych. Zdobądź swój klucz i wykonaj swoje pierwsze połączenie już dziś.