Dokumentacja APIDEL

Usuwanie witryny

Zatrzymaj monitorowanie witryny i usuń z uwierzytelnionego konta wszystkie przypisane do niej słowa kluczowe.

DELETEhttps://ai.redreplier.com/ai-app/api/v1/websites/{websiteId}

Zatrzymaj monitorowanie witryny i usuń z uwierzytelnionego konta wszystkie przypisane do niej słowa kluczowe.

Token Bearer (token API RedReplier)

Uwierzytelnianie

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

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • websiteId (ścieżka, UUID, wymagany): Witryna, której monitorowanie ma zostać zatrzymane.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca potwierdzenie usunięcia.

  • deleted (boolean): Zawsze true, gdy usunięcie się powiedzie.

Przykładowe żądanie

curl -X DELETE https://ai.redreplier.com/ai-app/api/v1/websites/11111111-1111-4111-8111-111111111111 \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Uwagi

Ta operacja zatrzymuje monitorowanie, więc przed wywołaniem upewnij się, że to właściwa witryna. Aktywne słowa kluczowe tej witryny zwalniają miejsca w planie, dlatego najstarsze oczekujące słowa z innych witryn, które się w nich mieszczą, stają się aktywne i zaczynają być monitorowane.

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 token jest nieprawidłowy 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 danych uwierzytelniających, 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 przypisanego do tokena.
  • 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 DELETE \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10 \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "deleted": true
}