Skip to content
Kordoni juhised

API ülevaade

Kordoni API võimaldab luua skripte ja rakendusi protsesside automatiseerimiseks, Kordoniga integreerimiseks ja Kordoni funktsionaalsuse laiendamiseks. Näiteks saab kasutada API-t varade sünkroniseerimiseks varahalduse süsteemiga.

Iga REST API otspunkt on dokumenteeritud eraldi ning grupeeritud vastavalt ressursile, mida need peamiselt mõjutavad.

Iga REST API päring sisaldab HTTP meetodit ja teekonda. Sõltuvalt otspunktist võib olla vajalik määrata ka päised (headers), autentimisinfo, päringu parameetrid (query parameters) või päringu sisu (body).

Kordoni REST API järgib HTTP standardeid, kasutades iga tegevuse jaoks tähenduslikult sobivaimat meetodit.

  • GET Kasutatakse ressursside pärimiseks.
  • POST Kasutatakse ressursside loomiseks.
  • PATCH Kasutatakse ressursside osaliseks muutmiseks.
  • DELETE Kasutatakse ressursside kustutamiseks.

Baasaadress

Section titled “Baasaadress”

Kõik API päringud tuleb teha aadressile:

https://SINU_KORDONI_URL/api/v1/

Kirjelduse väljad

Section titled “Kirjelduse väljad”

Paljud objektid Kordoni API-s sisaldavad description välja, mis toetab lihtsat HTML-vormindust. Kordon kasutab rikastatud teksti (rich text) haldamiseks Lexical WYSIWYG redaktorit. Ressursside loomisel või uuendamisel saab kirjeldustes kasutada järgmisi HTML-elemente:

  • Lõigud: <p>Tekst siin</p>
  • Paks kiri: <strong>Paks tekst</strong> või <b>Paks tekst</b>
  • Loendid: <ul><li>Element</li></ul> või <ol><li>Element</li></ol>
  • Lingid: <a href="url">Lingi tekst</a>

Näide:

{
  "description": "<p>See on <strong>vormindatud</strong> kirjeldus.</p>"
}

API Ressursid

Section titled “API Ressursid”