Dokumentacja API

Pierwsze kroki z API RedReplier

API RedReplier pozwala zewnętrznym narzędziom, automatyzacjom i agentom AI zarządzać monitorowaniem wzmianek na Reddicie, Hacker News, X, Bluesky i Facebooku. Za jego pomocą utworzysz monitorowane strony, zarządzisz słowami kluczowymi, przejrzysz wzmianki ocenione przez AI, sprawdzisz podgląd zmian w rozliczeniu słów kluczowych i skonfigurujesz alerty e-mail. API nigdy niczego nie nalicza ani nie zmienia planu: plan zmienia się w aplikacji RedReplier.

Bazowy URL: https://ai.redreplier.com/ai-app/api/v1

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Konto wynika z tokena API. Nie przekazuj identyfikatorów konta ani organizacji. Każde wywołanie działa w jednym obszarze roboczym: bez opcjonalnego nagłówka X-Workspace-Id trafia do domyślnego. Logowanie OAuth, na przykład przez konektor Claude lub ChatGPT, daje dostęp do wszystkich obszarów roboczych, do których należy dana osoba, we wszystkich organizacjach. Wywołaj Lista obszarów roboczych, aby je wyświetlić, i wyślij wybrany id w X-Workspace-Id. Klucz API należy do jednego obszaru roboczego, więc wyślij jego własny identyfikator albo pomiń nagłówek.

X-Workspace-Id: acct_7dK9pQ2

Zacznij od Lista stron, aby poznać identyfikatory stron i słów kluczowych.

Główne zasoby:

  • Website: monitorowany produkt, domena lub marka.
  • Keyword: fraza dopasowywana dla strony na Reddicie, Hacker News, X, Bluesky i Facebooku.
  • Mention: dopasowany post lub komentarz z Reddita, Hacker News, X, Bluesky albo Facebooka z oceną relevanceScore od 0 do 100.
  • Alert settings: częstotliwość e-mailowych podsumowań o nowych trafnych wzmiankach.

Statusy słów kluczowych: PENDING, ACTIVE, DISABLED, SUSPENDED. Statusy wzmianek: NEW, APPROVED, REJECTED.

Endpointy REST

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: Nagłówek X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, w tym identyfikator innego obszaru roboczego wysłany z kluczem API. Treść odpowiedzi zawiera code: "workspace_access_denied" i workspaceId. Kod 403 z code: "subscription_required" oznacza, że plan obszaru roboczego nie obejmuje dostępu do API. Kod 403 z code: "permission_denied" oznacza, że twoja rola w obszarze roboczym nie ma uprawnienia wymaganego przez wywołanie: RedReplier wymaga redreplier.write, które mają Administrator i Edytor. Taka odpowiedź podaje requiredPermission oraz twoją rolę w polu role.
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Każda odpowiedź zawiera RateLimit-Policy, RateLimit-Limit, RateLimit-Remaining i RateLimit-Reset, a kod 429 dodaje Retry-After w sekundach. Limity są liczone na klucz API.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.

Odmowa dostępu do obszaru roboczego wygląda tak:

{
  "statusCode": 403,
  "error": "Forbidden",
  "code": "workspace_access_denied",
  "workspaceId": "acct_3Hm8XwR",
  "message": "You have no access to workspace acct_3Hm8XwR. Call GET /workspaces to list the workspaces you can use, and send one of those ids in the X-Workspace-Id header."
}