Sprawdzanie backlinków strony przy publikacji krok po kroku
Jeden webhook, jedno wywołanie HTTP, jedna decyzja. Ta instrukcja przeprowadzi zespół headless CMS przez konfigurację hooka, wywołania oraz przypadki awaryjne.
Zespół badawczy Contentin ·
Określ, co może robić bramka
Sprawdzanie backlinków strony w przepuście wydania to niewielkie zadanie. Trzymaj je w małej skali. Najtrudniejszą częścią jest określenie, na co może wpłynąć wynik, ponieważ graf linków odświeżany co miesiąc nie może sam wstrzymać publikacji strony.
Sugerujemy, aby bramka generowała ostrzeżenie, zapisywała log i pozwalała na kontynuację budowania. Domyślne ustawienia mogą się zmieniać. Twarde blokady powinny dotyczyć rzeczy, które kontrolujesz, takich jak uszkodzony kod HTML lub brakujący tag canonical. Dane o linkach to sygnał, a sygnały ulegają zmianom.
Zapisz to na papierze. Zrób to przed napisaniem kodu. Jednozdaniowa polityka, np. „ostrzedź redaktora, oznacz wpis, nigdy nie zatrzymuj wdrożenia”, oszczędzi długich dyskusji o 18:00 w dniu wydania. Powie też kolejnemu inżynierowi, które błędy były zamierzone, a które to wady, co ma większe znaczenie, niż się wydaje. Przeglądaj ją raz na kwartał.
Sześć kroków od kliknięcia publikacji do zapisania notatki
1
Wybierz wyzwalacz
Subskrybuj zdarzenie publikacji w swoim CMS. Contentful, Sanity i Strapi mogą wywołać URL, który należysz, gdy wpis jest publikowany, a Storyblok i Payload również oferują webhooki lub hooki. Odfiltruj typy treści, które zawierają URL-e wychodzące lub canonical.
2
Sprowadź URL do domeny
API przyjmuje domenę w q, więc https://www.example.com/blog/post?x=1 musi zostać sprowadzone do example.com. Zdecyduj raz, jak traktujesz www, i przetestuj jedną prawdziwą domenę na darmowej akcji domain przed rozpoczęciem budowania.
3
Najpierw wywołaj darmową akcję
overview nie kosztuje nic. Jeśli wynik jest skąpy, domena może być nowa lub po prostu nieznana naszemu indeksowi. To nie dowodzi niczego złego.
4
Wydawaj kredyty tylko gdy zadziała reguła
Gdy Twoja reguła każe spojrzeć bliżej, wywołaj backlinks z per=100. To 2 kredyty, niezależnie od liczby wierszy, więc poproś o użyteczną stronę wierszy, a nie dziesięć małych.
5
Zapisz notatkę, a nie surowy JSON
Zapisz krótkie werdykty w polu własnym, wraz z datą sprawdzenia. Surowe odpowiedzi rozdużają wpisy i szybko się starzeją, ponieważ indeks zmienia się co miesiąc.
6
Awaria miękką
HTTP 401 oznacza, że klucz jest nieobecny lub błędny, więc zalertuj człowieka. HTTP 402 oznacza, że zabrakło kredytów. Każdy inny błąd: zaloguj go, pomiń sprawdzenie, pozwól na publikację.
Gdzie znajduje się klucz i co powinien zrobić 402
Każde płatne wywołanie zawiera Twój klucz, albo w stringu zapytania, albo w nagłówku Bearer. Preferuj nagłówek. String zapytania może trafić do logów serwera i śladów proxy, a nagłówek zwykle tam nie trafia.
Przechowuj klucz jako sekret w swojej platformie hostingowej, nigdy we wpisie. Redaktorzy mogą odczytać dowolne pole, które mogą otworzyć, ale środowisko funkcji jest zwykle widoczne tylko dla osób zarządzających wdrożeniami.
Gdzie powinien żyć klucz?
Klucz, który wycieknie, może wydać saldo na Twoim koncie, więc traktuj go jak hasło. Trzymaj go z dala od repozytorium i CMS, oraz zmień go, jeśli plik logów kiedykolwiek pokaże go w postaci jawnej.
Oznacz własne logi nazwą hooka. Wydanie jest wtedy łatwe do prześledzenia do jednej funkcji, nawet gdy kilka hooków dzieli to samo konto.
Czy narzędzie no-code może wykonać wywołanie?
Tak, gdy narzędzie ma krok zwykłego żądania HTTP. Wiele kreatorów automatyzacji może wysłać GET z stringiem zapytania i odczytać z powrotem JSON, więc darmowa akcja overview nie wymaga żadnego kodu.
Zacznij tylko od darmowych akcji. Przepływ, który uruchamia się przy każdym zapisaniu wersji roboczej, może wydać kredyty szybciej, niż redaktor to zauważy, więc dodaj krok płatny, gdy darmowe wywołania działają cicho przez jakiś czas.
Co powinien wywołać 402?
402 oznacza, że saldo jest puste. Nic nie mówi o stronie. Pomiń płatne sprawdzenie, zaloguj zdarzenie i wyślij jedno ostrzeżenie do osoby, która doładuje konto, a następnie pozwól na publikację.
Ustaw alarm salda znacznie powyżej zera, aby ostrzeżenie nadeszło, gdy wciąż jest czas na doładowanie. Pętla ponownych prób nie pomoże tutaj, ponieważ każde wywołanie zawiedzie w ten sam sposób, dopóki ktoś nie doda kredytu. Tabela kosztów zawiera dane.
Przetestuj dwa wywołania z terminala
Uruchom te raz przeciwko domenie, którą znasz, zanim hook zrobi to za Ciebie. Przeczytaj pole _credits w drugiej odpowiedzi.
bash
# free, no key
curl -s "https://contentin.app/api.php?action=overview&q=example.com"
# 2 credits, key in a header
curl -s -H "Authorization: Bearer sk_live_..." \
"https://contentin.app/api.php?action=backlinks&q=example.com&per=100"
Która domena trafi do parametru q
API przyjmuje gołą domenę w q, więc pełny URL musi zostać najpierw sprowadzony. Zapisz to sprowadzenie raz, w jednej funkcji. Następnie przetestuj je na prawdziwych URL-ach.
Linki względne i brakujące schematy to przypadki, które zwykle łamią hooka. Sprowadzenie, które działa na czystych przykładach, może nadal zawieść na brudnych URL-ach, które redaktor wkleja o 17:00.
Czy www zmienia odpowiedź?
Może, a uczciwym sposobem, aby się o tym przekonać, jest pytanie. Uruchom darmową akcję domain na obu formach jednej strony, którą znasz, a następnie porównaj dwie odpowiedzi obok siebie.
Niezależnie od wybranej reguły, zapisz ją w komentarzu kodu, aby kolejny inżynier nie musiał zgadywać. Komentarz nic nie kosztuje i oszczędzi długiej dyskusji później.
A co z przekierowaniami i poddomenami?
Wyślij hosta, na który faktycznie trafią Twoi czytelnicy, a nie link, który redaktor wkleił lata temu. Jeśli to przekierowanie, sprowadź ostateczny adres i zignoruj przeskoczenie po drodze.
Blog na własnej poddomenie to decyzja ocenna. Zdecyduj z góry, czy jest sprawdzany samodzielnie, czy razem z domeną nadrzędną, i zapisz ten wybór obok reguły.
Lista kontrolna przed wydaniem dla hooka
Hook uruchamia się tylko przy publikacji, nie przy każdym zapisaniu wersji roboczej
URL jest sprowadzany do gołej domeny przed wywołaniem
Darmowe akcje uruchamiają się najpierw, a kredyty są wydawane tylko przy flagie
401 i 402 mają各自的 alert i各自的 wiadomość
Ustawiony jest timeout, więc wolne API nigdy nie zablokuje redaktora
Zapisana notatka zawiera datę, więc nikt nie pomyli jej z danymi na żywo
Ten sam wpis opublikowany dwukrotnie nie rozlicza się dwukrotnie (zobacz listę mitów)
Ktoś przeczytał tabelę kosztów dla Twojego miesięcznego wolumenu
Co logować, a co zostawić poza wpisem
Wiersz logu dla każdego pominiętego sprawdzenia to najtańszy ślad audytowy, jaki możesz zbudować. Zapisz ID wpisu, domenę, którą wysłałeś, kod statusu i czy krok płatny został uruchomiony. Zazwyczaj to wystarczy.
Zapisana notatka pozostaje krótka i datowana, jak mówią powyższe kroki. Pełne odpowiedzi należą do Twoich własnych logów, jeśli należą gdziekolwiek, ponieważ są duże i szybko się starzeją.
Które pola należą do wiersza logu?
Zacznij od ID wpisu i wersji publikacji. Powtórzony webhook pojawi się wtedy jako ta sama para dwukrotnie, co jest dokładnie tym, co chcesz zobaczyć.
Dodaj domenę, nazwę akcji, kod statusu i czas rozpoczęcia wywołania. Pozostaw sam klucz poza, ponieważ log, który go zawiera, staje się drugim miejscem, gdzie żyją sekrety.
Jak długo powinna żyć zapisana notatka?
Tak długo, jak żyje wpis, chyba że nowsze sprawdzenie go zastąpi. Liczy się to, że czytelnik może powiedzieć, jak stara jest notatka, ponieważ notatka z miesięcy temu wygląda jak dane na żywo.
Przetestuj hook na środowisku testowym przed uruchomieniem
Uruchom te cztery sprawdzenia, zanim ktoś zacznie polegać na hooku.
1
Odtwórz jedną przeszłą publikację
Uruchom hook z kopią wpisu, który już opublikowałeś. Porównaj zapisaną notatkę z tym, czego się spodziewałeś, i potwierdź, że ten sam wpis nie został rozliczony dwukrotnie.
2
Wypróbuj domenę zarejestrowaną niedawno
Użyj domeny partnera, która jest dla Ciebie nowa. Pusta lub skąpa odpowiedź powinna być zapisana jako nieznana, a nie jako awaria, a notatka powinna to mówić wprost.
3
Wymuś 402 celowo
Uruchom hook z kluczem na koncie testowym, którego saldo opróżniłeś. Potwierdź, że pominięcie, wiersz logu i alert wszystkie się uruchamiają, i że publikacja nadal dociera do budowania.
4
Przeczytaj wiadomość, którą widzi redaktor
Poproś kogoś spoza zespołu, aby przeczytał tekst błędu na głos. Jeśli nie mogą powiedzieć, co zrobić dalej, przepisz wiadomość przed dniem wydania. Post-mortem pokazuje, co kosztowała niejasna wiadomość jeden wymyślony zespół.
Czego hook nie widzi
Nasz indeks odświeża się mniej więcej raz w miesiącu. Link dodany po ostatnim odświeżeniu nie pojawi się, a link usunięty od tego czasu może nadal się pojawiać. Dla dowodu tego samego dnia użyj raportu Links w Google Search Console.
