iKorektor API v2.6

Informacje ogólne

  1. iKorektor API (interfejs programistyczny) umożliwia implementację funkcji autokorekty tekstu we własnych aplikacjach.
  2. Dostęp wymaga wygenerowania unikalnego klucza dostępu przesyłanego na adres e-mail; Twój adres służy wyłącznie do tego celu oraz do przekazywania ważnych informacji o zmianach (rzadko).
  3. Treści przesyłane do korekty nie są zapisywane.
  4. Limit użycia: 10000 przesłanych znaków na dobę na jeden klucz/adres IP.

Specyfikacja

Adres URL API:

https://api.ikorektor.pl

Parametry (POST lub GET):

Nazwa parametru Czy wymagany Opis
key tak Twój klucz dostępu.
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 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 „zakrywanie” 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.
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. Ukośnik zostaje usunięty z tekstu wynikowego.
Aby wyłączyć tę funkcję, prześlij wartość 0.
parags nie Dzielenie tekstu na akapity. Przesłana wartość liczbowa oznacza liczbę zdań na jeden akapit (dozwolone 0-10, gdzie 0 oznacza brak dzielenia na akapity).

Odpowiedź:

Status JSON Opis
200
{
    "text": "<tekst poprawiony>",
    "text_length": <długość tekstu źródłowego>,
    "today_calls_count": <liczba wywołań dzisiaj>,
    "today_chars_used": <liczba przesłanych znaków dzisiaj>,
    "daily_chars_limit": <aktualny limit dobowego użycia>
}
Wszystko przebiegło prawidłowo, zwrócono poprawiony tekst i dodatkowe informacje.
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
{
    [...]
    "text": "<tekst źródłowy>",
    "error": "LIMIT"
}
Korekta przesłanego tekstu spowodowałaby przekroczenie limitu użycia. Zwrócony tekst jest oryginalny (niepoprawiony).
503
{
    "error": "DB"
}
Błąd połączenia z bazą danych.
fb