Dokumentacja APIGET

Wykorzystanie zmian słów kluczowych

Sprawdź miesięczny limit edycji słów kluczowych na koncie, ile z niego wykorzystano i ile jeszcze zostało.

GEThttps://ai.redreplier.com/ai-app/api/v1/keywords/change-usage

Sprawdź miesięczny limit edycji słów kluczowych na koncie, ile z niego wykorzystano i ile jeszcze zostało.

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 bieżące wykorzystanie edycji słów kluczowych.

  • limit (number): Miesięczny limit edycji słów kluczowych; -1 oznacza brak limitu.
  • used (number): Edycje słów kluczowych wykorzystane w tym miesiącu.
  • remaining (number): Edycje słów kluczowych pozostałe w tym miesiącu; -1 oznacza brak limitu.
  • unlimited (boolean): Czy limit jest nieograniczony.

Przykładowe żądanie

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

Uwagi

Edycje słów kluczowych są nieograniczone we wszystkich obecnych planach, więc endpoint zwraca limit: -1, used: 0, remaining: -1 i unlimited: true. Pozostaje dostępny dla klientów, które planują budżet edycji. Dodawanie, wyłączanie, włączanie i usuwanie słów kluczowych nigdy nie było wliczane.

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/keywords/change-usage \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "limit": -1,
  "used": 0,
  "remaining": -1,
  "unlimited": true
}