Dla programistów i agencji

API CitationOne

Zlecaj audyty z własnego kodu i odbieraj wynik jako JSON. Ten sam silnik, który liczy raporty w panelu - wpięty w Twój CMS, skrypt albo dashboard klienta.

Dokumentacja APIWersja Markdown dla agentów
REST · JSON · api/v1
# 1. Zleć audyt
curl -X POST https://app.citationone.com/api/v1/audits \
  -H "Authorization: Bearer co_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/artykul", "keyword": "fraza kluczowa" }'

# 202 { "id": "job_V1StGXR8", "status": "queued" }

# 2. Odbierz wynik
curl https://app.citationone.com/api/v1/audits/job_V1StGXR8 \
  -H "Authorization: Bearer co_live_..."

# Albo pomiń krok 2: podaj "webhookUrl" przy zleceniu,
# a wynik wyślemy POST-em, podpisany HMAC-SHA256.

Dostęp na klucz API

Zamiast loginu i hasła wysyłasz klucz w nagłówku żądania. Tworzysz go i cofasz w panelu; pokazujemy go jeden raz, a w bazie zostaje wyłącznie jego nieodwracalny skrót.

Zakresy kluczy

Klucz może mieć sam odczyt albo także prawo zlecania audytów. Żądanie poza swoim zakresem dostaje odmowę, więc klucz wpięty w cudzy skrypt nie wyda Twoich kredytów.

Praca w tle

Audyt liczy się kilka minut, więc zlecenie kończy się od razu - dostajesz numer zadania i wolne połączenie. Po wynik wracasz osobnym zapytaniem.

Powiadomienie zamiast odpytywania

Podaj swój adres w polu webhookUrl, a gotowy wynik przyjdzie do Ciebie sam, z podpisem potwierdzającym nadawcę. Błędy też przychodzą, a zlecenie masowe wysyła osobne powiadomienie za każdy audyt.

Audyt tekstu przed publikacją

Zamiast adresu strony możesz wysłać sam tekst i sprawdzić szkic, nową wersję albo copy dla strony, której jeszcze nie ma. Ten sam zestaw wymiarów, ten sam 1 kredyt.

Cały raport jako JSON

Content Quality Score, jedenaście wymiarów z listą problemów i E-E-A-T w komplecie, rekomendacje w parach przed i po, porównanie z konkurencją z Google i ChatGPT oraz pokrycie pytań Fan-Out.

Zlecenia masowe

Całą listę adresów wysyłasz jednym żądaniem, a serwer ustawia je w kolejkę i liczy po kolei. W trakcie sprawdzasz postęp, a paczkę możesz w każdej chwili zatrzymać.

Projekty i historia zleceń

Przy zleceniu nadajesz audytowi nazwę projektu, a potem filtrujesz po niej listę - obok statusu, domeny i zakresu dat. Osobne zapytanie zwraca same projekty wraz z liczbą audytów.

Raport do wysłania klientowi

Audyt może dostać publiczny adres tylko do odczytu, który wyślesz klientowi bez zakładania mu konta. Z datą wygaśnięcia albo bezterminowo.

Rozliczenie w kredytach

Jeden audyt z API kosztuje 1 kredyt - dokładnie tyle samo, co audyt zlecony w panelu. Bez osobnego abonamentu; saldo i historię zużycia czytasz z API.

Dokumentacja czytelna dla agentów AI

Ta sama dokumentacja jest wystawiona jako czysty Markdown pod adresem /api-docs.md. Wskaż ten adres asystentowi (Claude, ChatGPT, Cursor), a dostanie pełny opis API bez przedzierania się przez kod strony - z zachowanymi tabelami i blokami kodu. Obie wersje powstają z jednego źródła, więc nie da się ich rozjechać.

https://app.citationone.com/api-docs.md

Dokumentacja jest po angielsku - razem z opisami pól i przykładami.

Klucze API tworzysz w panelu, w zakładce dla programistów. Pierwsze 3 audyty są darmowe - również przez API.

Utwórz klucz API