iKorektor API v2.81.1

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.pl

Parametry 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.
uppercase nie 50 Wartość procentowa liczby wielkich liter w tekście, od której iKorektor zamienia wszystkie litery na małe (tekst napisany wielkimi 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 znaku „\” (ukośnik wsteczny) przed danym wyrazem. Jest to „furtka” umożliwiająca świadome użycie błędu w tekście poddawanemu autokorekcie, mające stanowić np. formę żartu / ironii. Użyty znak ukośnika zostaje usunięty z tekstu wynikowego.
info nie 0 Zwracanie dodatkowych informacji o poprawionych błędach i ew. sugestiach korekty (więcej informacji w przykładowym wywołaniu).

Przykładowe wywołanie

GET | POST  https://api.ikorektor.pl?text=ikorekor+poprawia+bledne+slowa+a+gdy+niejest+pewnien+pokazuje+sugtesie&key=demo&info=1

Odpowiedź (JSON):

{
    "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
    "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
            "position": 0 // pozycja słowa w tekście wynikowym licząc od zera
        },
        {
            "error": "sugtesie",
            "correction": "sugestie",
            "position": 64
        }
    ],
    "suggs": [ // słowa poprawne z propozycjami ewentualnych korekt zależnych od kontekstu
        {
            "word": "poprawia",
            "suggs": [
                "poprawią"
            ]
        },
        {
            "word": "pokazuje",
            "suggs": [
                "pokazuję"
            ]
        },
        {
            "word": "sugestie",
            "suggs": [
                "sugestię"
            ]
        }
    ],
    "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"
            ]
        }
    ],
    "text": "IKorektor poprawia bledne słowa, a gdy nie jest pewien pokazuje sugestie." // tekst poprawiony
}

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

API Darmowy

  • 500 wywołań na dzień
  • 50 000 sprawdzonych znaków na dzień
  • 5000 znaków w jednej korekcie
  • 10 wywołań na minutę

0 złwystarczy pobrać klucz dostępu

Pobierz klucz

API Elastyczny

  • 500+ wywołań na dzień
  • 50 000+ sprawdzonych znaków na dzień
  • 5000+ znaków w jednej korekcie
  • 10+ wywołań na minutę
  • panel statystyk

0,01 złza każde 1000 znaków ponad limit 0,005 złza każde wywołanie ponad limit

Kontakt

Wymagający

  • 5000 wywołań na dzień
  • 500 000 sprawdzonych znaków na dzień
  • 10 000 znaków w jednej korekcie
  • 25 wywołań na minutę
  • panel statystyk

29 złmiesięcznie
-20% przy płatności rocznej

Kontakt

Maksymalny

  • bez limitu wywołań na dzień
  • bez limitu sprawdzonych znaków na dzień
  • 25 000 znaków w jednej korekcie
  • 50 wywołań na minutę
  • panel statystyk

59 złmiesięcznie
-20% przy płatności rocznej

Kontakt

Limity w planie darmowym i elastycznym mogą ulegać zmianom.

Pobranie klucza



Staramy się, by reklamy na naszej stronie nie były uciążliwe. Dzięki nim możliwe jest utrzymanie darmowej funkcjonalności iKorektora. Rozważ proszę dodanie naszej strony do wyjątków programu blokującego reklamy. Zobacz jak to zrobić.

fb