Informacije na ovoj stranici namijenjene su isključivo profesionalnim korisnicima, tj. onima koji svoje sustave za uređivanje tekstova namjeravaju opremiti mogućnošću ispravljanja pogrešaka koju nudimo. 

Ako ne znate što znači API, ovo nije stranica za vas!

Provjeru svog teksta možete obaviti na naslovnoj stranici usluge.

Profesionalnim korisnicima omogućujemo spajanje na jezgrenu uslugu putem aplikacijskog programskog sučelja. Zahtjev se šalje putem protokola HTTPS, metodom POST. Odgovor se šalje u tekstnom formatu JSON.

Format zahtjeva klijentske strane

POST zahtjev postavlja se na resurs https://ispravi.me/api/ispravi kao application/x-www-form-urlencoded ili application/json. Zahtjev sadrži sljedeće parametre:

text=<tekst za provjeru>

Tekst za provjeru šalje se kodiran u formatu UTF-8.

context=(on|off)

on – tražena je kontekstna provjera teksta
off – tražena je standardna provjera teksta (default)

punctuation=(on|off)

on – tražena je provjera razmaka ispred i iza znakova interpunkcije (default)
off – nije tražena provjera razmaka ispred i iza znakova interpunkcije

showinfo=(on|off)

on – tražen je ispis dodatne informativne poruke vezane uz svaku pogrešku, primjerice, relevantni pravopisni savjet (default)
off – nije tražen ispis dodatne informativne poruke

app=<identifikator korisnika>

Jedinstveni identifikator korisnika usluge – registrirajte svoj API-ključ.

Primjer zahtjeva:

POST /api/ispravi HTTP/1.1
Host: ispravi.me
...
<prazni red>
text=pogrešon+napsiana+rijeć&context=on&punctuation=on&app=ASDAAF-DAAA-AFASD-DAFDASA

Format odgovora poslužiteljske strane

Odgovor poslužitelja šalje se u formatu JSON. Odgovor je opisan u primjeru ispod:

{
   "request" : {
      "APP" : <aplikacija korisnika>       # default "WebClient"
      "remoteip" : <ip_adresa_klijenta>,
      "user" : {
           "newuser" : <true|false>,         # novi korisnik?
           "key" : <identifikator korisnika>, 
           "from" : <mreža_korisnika>
      },
      "options" : {
           "contextual" : <true|false>,      # tražena kontekstna provjera?
           "fixpunctuation" : <true|false>,  # tražena je provjera razmaka oko znakova interpunkcija?
           "showinfo" : <true|false>,        # tražena je informativna poruka vezana uz pogrešku?
           "displaymode" : <tab|standalone>, # način prikaza kod korisnika - tab u pregledniku ili PWA
      },
      "text" : {
           "contenttype" : <mime-type zadanog teksta>,
           "language" : [
                         "hr|en|sr|sl|...",   # oznaka jezika prema  ISO-639-1
                         <0-100>              # pouzdanost procjene
                        ]
           "length" : <duljina obrađenog teksta u znakovima>,
           "words" : <broj riječi u tekstu>
      }
   },
   "status" : {
      "time" : <vrijeme obrade u sekundama>,
      "text" : <tekstni status obrade>,
      "href" : <URL na objašnjenje pogreške>,
      "code" : <brojčani status obrade>
   },
   "response" : {
      "errors" : <broj grešaka>,
      "error" : [
         {
            "message" : <poruka vezana uz pronađenu pogrešku, npr. obrazloženje ili savjet>
            "header" : <naslov koji opisuje pogrešku>
            "suspicious" : <sumnjiva riječ>,
            "length" : <duljina pogrešne riječi>,
            "suggestions" : [
               <lista predloženih ispravaka>
            ],
            "occurrences" : <broj takvih pogrešaka>,
            "position" : [
               <indeksi na kojima se nalazi pogrešno napisana riječ, prvi znak je 0>
            ],
            "class" : (extreme|major|moderate|minor|unclassifiable|case-mix|alphanum-mix|grammar|pleonasm|dual|punctuation) 
         },
         {
            # ponavlja se za svaku pogrešku
         },
      ]
   }
}