iKorektor API v2.0

  1. Informacje ogólne
  2. Pobranie klucza
  3. Specyfikacja API

1. Informacje ogólne

2. Pobranie klucza

Adres e-mail:

2. Specyfikacja API

POST | GEThttp://api.ikorektor.pl/text

Autokorekta błędów w przesłanym tekście.

Parametry:

Nazwa parametru Czy wymagany Opis
key tak Twój klucz dostępu do API.
text tak Tekst, który ma zostać poddany korekcie. W przypadku długich tekstów zalecane przesłanie metodą POST.
uppercase nie Tekst napisany wielkimi literami może uniemożliwić właściwą korektę błędów. Aby temu zapobiec, iKorektor zamienia wszystkie litery na małe gdy liczba wielkich liter stanowi co najmniej połowę (50%) liczby wszystkich znaków w tekście.

Parametr uppercase umożliwia zmianę ww. procentu. Przykładowo, nadając mu wartość 0 – zamiana liter na małe nastąpi bezwzględnie zawsze (niezalecane – zamienione zostaną również np. poprawne akronimy, np. AGD na agd).
Z kolei wartość 100 spowoduje zamianę tylko wtedy, gdy CAŁY tekst jest napisany „capsem” – również niezalecane.
profanity nie Parametr włączający „wygwiazdkowanie” słów wulgarnych. W zależności od liczby oczekiwanych gwiazdek należy nadać mu wartość z przedziału 1-3.
gateway nie 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 popełnienie błędu będącego np. formą żartu/ironii.
Nadaj parametrowi gateway wartość 0, aby wyłączyć taką możliwość.

Odpowiedź:

Status JSON Opis
200
{"text":"<tekst po korekcie>"}
Wszystko przebiegło prawidłowo, zwrócono poprawiony tekst.
400
{"error":"NO_TEXT"}
Brak tekstu do korekty lub jest zbyt krótki (minimum 3 znaki).
400
{"error":"INVALID_KEY"}
Nieprawidłowy klucz API (lub jego brak).
429
{"error":"LIMIT"}
Korekta przesłanego tekstu spowodowałaby przekroczenie limitu użycia. Możesz spróbować przesłać krótszy tekst, jeśli łączna liczba dotychczas przesłanych znaków na to pozwala (sprawdzisz to metodą /usage, o której niżej).
503
{"error":"DB"}
Błąd połączenia z bazą danych.

GEThttp://api.ikorektor.pl/usage/{api_key}

Informacje o użyciu. Funkcja dostępna niebawem, obecnie zwraca błąd.
fb