API korekty tekstu
iKorektor API to usługa umożliwiająca wykorzystanie funkcjonalności iKorektora bezpośrednio we własnych aplikacjach. Dostęp do API wymaga wygenerowania unikalnego klucza przesyłanego na adres e-mail. Treści przesyłane do korekty nie są gromadzone.Specyfikacja
URL
https://api.ikorektor.plParametry wywołania
Nazwa parametru | Czy wymagany | Wartość domyślna | Opis |
key | tak | - | Klucz dostępu do API. |
text | tak | - | Tekst, który ma zostać poddany korekcie. Z uwagi na ograniczenia metody GET, zalecane przesyłanie dłuższych tekstów metodą POST. |
lcase_at | nie | 50 | Procentowy udział dużych liter w tekście, od którego litery zamieniane są na małe (tekst napisany dużymi literami może utrudnić właściwą korektę błędów). Funkcja ma także zastosowanie, gdy nie chcemy tekstów pisanych „caps lockiem”. |
profanity | nie | 0 | Cenzurowanie słów wulgarnych znakiem gwiazdki. Przesłana wartość liczbowa oznacza liczbę znaków do zakrycia w słowie, przy czym wartość 6 lub wyższa spowoduje zakrycie zawsze całego słowa, a wartość 0 to brak zakrywania. |
parags | nie | 0 | Dzielenie tekstu na akapity. Przesłana wartość liczbowa oznacza liczbę zdań na jeden akapit (dozwolone 0-10, gdzie 0 oznacza brak dzielenia na akapity). |
gateway | nie | 1 | Domyślnie iKorektor umożliwia wyłączenie z korekty pojedynczych słów poprzez wpisanie znaków „\\” (podwójny ukośnik wsteczny) przed danym wyrazem. Jest to „furtka” umożliwiająca świadome użycie błędu w tekście poddawanemu autokorekcie. Ukośniki zostają usunięte z tekstu wynikowego. |
info | nie | 0 | Zwracanie dodatkowych informacji o poprawionych / znalezionych błędach (patrz przykładowe wywołanie poniżej). |
trim | nie | 1 | Usuwanie białych znaków z końca tekstu. |
dot_end | nie | 1 | Dodawanie brakującej kropki na końcu tekstu oraz poszczególnych akapitów. |
Przykładowe wywołanie
GET | POST https://api.ikorektor.pl?text=ikorekor+poprawia+bledne+slowa+a+gdy+niejest+pewnien+pokazuje+sugtesie&key=demo&info=1Odpowiedź (JSON):
{ "text": "IKorektor poprawia bledne słowa, a gdy nie jest pewien pokazuje sugestie.", // tekst poprawiony "today_calls": 1, // liczba wywołań dzisiejszych "today_chars": 70, // liczba przesłanych znaków dzisiaj dla danego klucza "text_length": 70, // długość tekstu źródłowego // dodatkowe dane zwracane, gdy istnieje parametr info=1: "succs": [ // błędy w tekście, które zostały automatycznie poprawione { "error": "ikorekor", // słowo błędne z tekstu źródłowego "correction": "IKorektor", // autokorekta słowa z tekstu zwróconego "position": 0, // pozycja słowa w tekście wynikowym licząc od zera "comments": [ // komentarze wyjaśniające jakie błędy zostały poprawione "poprawienie błędów ortograficznych / literówek", "rozpoczęcie zdania dużą literą" ] }, { "error": "slowa", "correction": "słowa", "position": 26, "comments": ["uzupełnienie polskich znaków diakrytycznych"] }, { "error": "", "correction": ",", "position": 31, "comments": ["dodanie przecinka;https://polszczyzna.pl/gdzie-postawic-przecinek/"] }, { "error": "", "correction": " ", "position": 42, "comments": ["dodanie odstępu między słowami"] }, { "error": "pewnien", "correction": "pewien", "position": 48, "comments": ["poprawienie błędów ortograficznych / literówek"] }, { "error": "sugtesie", "correction": "sugestie", "position": 64, "comments": ["poprawienie błędów ortograficznych / literówek"] }, { "error": "", "correction": ".", "position": 72, "comments": ["dodanie kropki na końcu zdania"] } ], "fails": [ // błędy w tekście, których nie udało się automatycznie poprawić; mogą zawierać propozycje poprawnych słów { "error": "bledne", "suggs": [ "blednę", "błędne" ] } ] }
Kody błędów
Status | Odpowiedź (JSON) | Opis |
400 |
{ "error": "INVALID_KEY" } |
Nieprawidłowy klucz API (lub jego brak). |
400 |
{ "error": "NO_TEXT" } |
Brak tekstu do korekty lub jest zbyt krótki (minimum 3 znaki). |
400 |
{ "error": "TXT_LEN" } |
Zbyt długi tekst do korekty. |
400 |
{ "error": "CHARS_LMT" } |
Przesłany tekst spowoduje przekroczenie dobowego limitu sprawdzonych znaków. |
429 |
{ "error": "CALLS_LMT_MIN" } |
Osiągnięto limit wywołań na minutę. |
429 |
{ "error": "CALLS_LMT_DAY" } |
Osiągnięto limit wywołań na dobę. |
Dostępne plany
Darmowy
- do 100 wywołań na dzień
- do 15 000 łącznie sprawdzonych znaków na dzień
- do 10 wywołań na minutę
- do 5000 znaków w jednym wywołaniu
0 złwystarczy pobrać klucz dostępu
Pobierz kluczPotrzebujesz więcej? Skontaktuj się, by dobrać odpowiedni dla siebie plan.