API śledzenia pozycji, CLI i SDK

OdbiorcyProgramiściInżynierowie danych

Jedno API śledzenia pozycji z OpenAPI, CLI i SDK TypeScript, Python oraz Go. Uruchamiaj sprawdzenia i czytaj historię z kodu.

Następnie utwórz klucz API w Settings / Developers

Płatne zapytania na własnym koncie DataForSEO lub SerpApi · Wyceny są bezpłatne · Własny hosting (AGPL-3.0)

REST v1OpenAPI161 operacji

POST /api/v1/keywords/{id}/checks

export BISIBILITY_BASE_URL=https://eu.bisibility.com/api/v1curl -sS -X POST \  "$BISIBILITY_BASE_URL/keywords/kw_a00000000000000000000000/checks" \  -H "Authorization: Bearer $BISIBILITY_API_KEY" \  -H "Idempotency-Key: run-check-001" \  -H "Content-Type: application/json" \  -d '{"max_cost_cents": 1}' \  | jq '{position, previous_position, ranking_url, cost_cents}'
WynikHTTP 201
{  "position": 4,  "previous_position": 7,  "ranking_url": "https://example.com/rank-tracker",  "cost_cents": 0.06}

201, gdy sprawdzenie kończy się w trakcie żądania; 202 z identyfikatorem uruchomienia, gdy trafia do kolejki.

Przykładowe wywołanie z przykładowymi danymi.

REST API

REST API śledzenia pozycji z publiczną specyfikacją OpenAPI

Każda operacja REST używana przez SDK i CLI to zwykłe wywołanie HTTPS opisane w publicznym dokumencie OpenAPI 3.1.

  • Klucze z zakresem, pokazywane raz. Każdy klucz ma zakres, termin ważności i miesięczne wydatki; przechowywany jest tylko hash.
  • Bezpieczne ponawianie. Wyślij klucz idempotencji przy zapisie; ponowienie w ciągu 24 godzin odtworzy pierwotną odpowiedź.
Klucze API

Klucze do API bisibility – każdy ma zakres i termin ważności.

Raport nocny
bsb_key_live_7hq2******

utworzono 20 wrz 2026, 23:44 · ostatnio użyty 28 wrz 2026, 02:17

Wydatki w miesiącu: $0.42

wygasa 19 gru 2026, 23:44
Sprawdzenia CI
bsb_key_live_k3m9******

utworzono 22 wrz 2026, 08:44 · nigdy nie użyto

Wydatki w miesiącu: $0.00

bez terminu ważności
Szybki start w dokumentacjiUtwórz klucz
  • Ogranicz koszt każdego płatnego wywołania. Sprawdzenia pozycji i przeglądy domen wycenione ponad limit są odrzucane; badania słów i linków traktują go jako limit stosowany w miarę możliwości. badanie słów kluczowych analiza linków przychodzących
  • Nadaj skryptom własny budżet. Miesięczny budżet API i agentów na dostawcę jest twardym limitem; aplikacja i zaplanowane sprawdzenia nadal działają.

Budżety dostawców

Ustaw miesięczny budżet dla każdego dostawcy. Użycie salda dostawcy uwzględnia wydatki z tego miesiąca, aby pozostały budżet odpowiadał dostępnemu saldu.

Dostawca
Aplikacja i harmonogramySprawdzenia uruchamiane w aplikacji oraz automatyczne sprawdzenia z harmonogramu.
API i agenciZapytania z API, MCP, SDK i CLI. Ustaw go, aby chronić się przed agentami, które wymknęły się spod kontroli.
DataForSEOGłówny
Budżet / miesiąc$20.003,12 USD w tym miesiącu · 4,05 USD w poprzednim miesiącuUżyj salda dostawcy
Budżet / miesiąc$5.000,42 USD w tym miesiącu · 0,31 USD w poprzednim miesiącu

Po osiągnięciu budżetu żądania tej powierzchni zatrzymują się do następnego miesiąca; druga powierzchnia działa dalej.

AnulujZapisz

SDK i CLI

SDK TypeScript, Python i Go oraz CLI

Trzy oficjalne SDK dają typowane zapytania i odpowiedzi. CLI wykonuje sprawdzenia, badania i eksport z terminala lub CI.

  • Funkcja oczekiwania dla każdego języka. Każdy SDK może uruchomić sprawdzenie pozycji i odczytać wynik. Wykonanie w kolejce zależy od środowiska wdrożenia.
  • Logowanie CLI w przeglądarce. Zaloguj się raz w przeglądarce, bez wklejania klucza.
  • Dla CI i skryptów. Czytaj klucz ze zmiennych środowiska i otrzymuj JSON.
npm install @bisibility/sdkimport { BisibilityClient } from "@bisibility/sdk";const bisibility = new BisibilityClient({  apiKey: process.env.BISIBILITY_API_KEY,  baseUrl: "https://eu.bisibility.com/api/v1",});const check = await bisibility.rankChecks.runAndWait("kw_a00000000000000000000000");console.log(check.position, check.previous_position, check.ranking_url, check.cost_cents);Runtime      Node 18+Wait helper  rankChecks.runAndWait

Webhooki

Podpisane webhooki SEO na zewnątrz, hooki wdrożeń do wewnątrz

Reguły alertów wysyłają do 10 endpointów HTTPS na projekt. Wdrożenia płyną w drugą stronę, z CI do bisibility.

  • Cztery rodzaje zdarzeń. Wyzwolone alerty, podsumowania, informacja o dziennym limicie i zdarzenie testowe.
  • Weryfikuj w kilku liniach. Każde doręczenie ma podpis i czas, które należy sprawdzić przed zaufaniem do niego.
  • Przyjmuj hooki wdrożeń. Skieruj Vercel, Netlify, Amplify lub CI na hook wdrożenia i odczytuj wdrożenia przez API.
POST https://example.com/hooks/bisibilityX-Bisibility-Timestamp: 1784980803X-Bisibility-Signature: sha256=4f1c…e9a2{  "event": "alert.fired",  "schemaVersion": 3,  "created_at": "2026-07-25T12:00:03.000Z",  "data": {    "headline": "Rank tracker dropped from #4 to #11",    "keyword": "rank tracker",    "before_position": 4,    "after_position": 11,    "condition_type": "position_drop",    "rule_name": "Important position drops",    "project_domain": "example.com",    "keyword_id": "kw_a00000000000000000000000"  }}

Własny hosting

To samo API na własnym serwerze

Aplikacja jest open source na AGPL-3.0, a CLI i SDK na Apache-2.0. Własna instancja udostępnia to samo API pod własnym adresem.

  • Przełącz jednym ustawieniem. Przejście między Cloud a własnym serwerem to zmiana bazowego URL w SDK lub CLI.
  • Przenieś swoją historię. Eksportuj pakiet projektu; import Cloud przywraca słowa i historię pozycji z tokenem przypisanym do projektu.
# Cloud (EU region)bisibility config set baseUrl https://eu.bisibility.com/api/v1# Your serverbisibility config set baseUrl https://rank.example.com/api/v1bisibility config set cloudUrl https://rank.example.combisibility auth loginbisibility export --format json --output dump.json

Czego jeszcze nie obsługuje

  • Klucze projektów pozwalają na 600 zapytań/min, osobiste tokeny na 120; przy własnym hostingu można to zmienić.
  • Listy z paginacją kursorem zwracają domyślnie 50 wierszy, maksymalnie 200 na stronę.
  • Webhooki alertów uruchamiają reguły, bez filtrów pojedynczych zdarzeń.
  • Działające demo jest tylko do odczytu i nie tworzy kluczy API.

Od klucza API do pierwszego sprawdzenia pozycji

Zarejestruj się, utwórz klucz API i wykonaj pierwsze wywołanie przez curl, CLI lub SDK.

Bezpłatne i open source (AGPL-3.0). Eksportuj dane w dowolnym momencie lub uruchom tę samą aplikację samodzielnie.