Dokumentacja APIGET

Lista stron

Wyświetl wszystkie monitorowane strony uwierzytelnionego konta RedReplier wraz z obiektami ich słów kluczowych.

GEThttps://ai.redreplier.com/ai-app/api/v1/websites

Wyświetl wszystkie monitorowane strony uwierzytelnionego konta RedReplier wraz z obiektami ich słów kluczowych.

Token Bearer (token API RedReplier)

Uwierzytelnianie

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena. Wyślij X-Workspace-Id, aby działać w obszarze roboczym innym niż domyślny; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

Ten endpoint nie przyjmuje parametrów ścieżki ani zapytania.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca obiekt z tablicą websites.

  • websites (Website[]): Monitorowane strony widoczne dla konta powiązanego z tokenem.

Obiekt Website

  • id (string): UUID strony.
  • accountGroupId (string): Grupa kont ustalona na podstawie tokena.
  • domain (string): Znormalizowana domena strony.
  • url (string): Adres URL strony.
  • name (string | null): Nazwa wyświetlana.
  • description (string | null): Kontekst używany do oceny trafności.
  • createdAt, updatedAt (ISO string | null): Znaczniki czasu utworzenia i aktualizacji w formacie ISO 8601 lub null.
  • keywords (Keyword[]): Obiekty słów kluczowych tej strony.

Obiekt Keyword

  • id (string): UUID słowa kluczowego.
  • websiteId (string): UUID strony nadrzędnej.
  • value (string): Tekst słowa kluczowego, do 255 znaków.
  • status (string): PENDING, ACTIVE, DISABLED lub SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Znaczniki czasu utworzenia i aktualizacji w formacie ISO 8601 lub null.

Przykładowe żądanie

curl -s https://ai.redreplier.com/ai-app/api/v1/websites \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Uwagi

Użyj tego endpointu na początku, aby poznać wartości websiteId i keywordId potrzebne w kolejnych wywołaniach.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/websites \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "websites": [
    {
      "id": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
      "accountGroupId": "acct_7dK9pQ2",
      "domain": "acmecrm.io",
      "url": "https://acmecrm.io",
      "name": "Acme CRM",
      "description": "CRM for small agencies that need pipeline tracking and client follow-up reminders.",
      "createdAt": "2026-05-22T10:15:30.000Z",
      "updatedAt": "2026-05-29T14:02:11.000Z",
      "keywords": [
        {
          "id": "73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d",
          "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
          "value": "agency CRM",
          "status": "ACTIVE",
          "createdAt": "2026-05-22T10:16:00.000Z",
          "updatedAt": "2026-05-29T14:02:11.000Z"
        }
      ]
    }
  ]
}