| Atrybut | Typ | Opis |
|---|---|---|
| title | string | Słowo do wyjaśnienia |
| forbiddenWords | string[] | Pięć słów, które nie mogą być użyte do wyjaśnienia tytułu |
| difficulty | string | "easy", "medium" lub "hard" |
Obecnie istnieją dwa endpointy. Pierwszy zwraca wszystkie karty przechowywane w bazie danych. Odpowiedź to tablica obiektów kart.
/api/cardsDrugi endpoint zwraca losowo wybraną kartę. Odpowiedź to pojedynczy obiekt - karta:
/api/cards/randomW obu wyżej wymienionych endpointach można dołączyć następujące parametry zapytania dotyczące języka i trudności.
language
Dołącz parametr language, aby otrzymać karty tylko w danym języku (en lub pl):
/api/cards?language=en/api/cards?language=pl
Nie podanie parametru language jest równoważne z podaniem language=en, więc
następujące endpointy są równoważne:
/api/cards/api/cards?language=enW obu powyższych przypadkach zostanie zwrócona tablica kart w języku angielskim.
difficulty
Dołącz parametr difficulty, aby otrzymać karty tylko o określonej trudności (easy, medium, or hard):
/api/cards?difficulty=easy/api/cards?difficulty=medium/api/cards?difficulty=hard
Jeśli parametr difficulty nie zostanie podany, to zostanie zwrócona następująca odpowiedź:
/api/cards Wszystkie karty o różnych trudnościach.
/api/cards/random Jedna karta o dowolnej trudności.
Bazowy URL jest prefiksem dla API:
https://taboocardsapi.com/api/Prefiks ten jest pominięty w całej dokumentacji. Powinien być zawsze dołączany podczas komunikacji z API.
Aby zapobiec złośliwym działaniom, istnieje limit 10000 zapytań do API dziennie. Wykonanie większej liczby zapytań spowoduje otrzymanie odpowiedzi z błędem o statusie 429 (Too Many Requests).