Zahtjevi

Detaljna dokumentacija naših API poziva. Autentifikacija je potrebna za sve pozive. API ključ možete pronaći na profilu.

info

URL adrese na ovoj stranici sadrže promjenljive dijelove koje je potrebno zamijeniti stvarnim vrijednostima prema vašem slučaju, na primjer:

https://test.mdocs-plus.si/document/api/default/view?id=2

GET pozivi

Zaglavlja (Headeri)

Polje	Tip	Opis	Zadana vrijednost	Obavezno
Authorization	Bearer Token	Token za autentifikaciju		✔️
expand	string	Proširena polja
fields	string	Polja koja vraća zahtjev
href	boolean	Vraća URL pojedinačnog dokumenta	false
dateFormat	string	Formatira polja datuma i vremena	php:d.m.Y H:i:s
dateFields	string	Formatira samo određena polja

Primjer

{
  "Authorization": "xfWuluzj...",
  "expand": "documentType.*,createdBy.name",
  "fields": "id,subject",
  "href": "true",
  "dateFormat": "php:d/m/Y",
  "dateFields": "created_at,updated_at"
}

Dohvati zapise

GET

https://{DOMAIN}/{CONTROLLER}/api/default

Opis

API poziv vraća sve rezultate kojima korisnik ima pristup.

// GET https://{DOMAIN}/document/api/default

{
  {
    "id": 1,
    "description": "xyz",
  },
  {
    "id": 2,
    "description": "123",
  },
  ...
}

---

Pogledaj zapis

GET

https://{DOMAIN}/{CONTROLLER}/api/default/view?id={ID}

Opis

API poziv vraća podatke zapisa sa određenim ID-jem, ako korisnik ima pristup njemu.

// GET https://{DOMAIN}/document/api/default/view?id=1

{
  "id": 1,
  "description": "xyz",
  ...
}

---

list-objects

GET

https://{DOMAIN}/{CONTROLLER}/api/default/list-objects?id={ID}&attribute={ATTR}

Opis

list-objects omogućava direktan pristup zapisu koji je sačuvan u određenom referentnom polju odabranog zapisa.

info

{ID} predstavlja identifikacioni broj zapisa iz kojeg želimo dobiti podatke referentnog polja
{ATTR} predstavlja naziv referentnog polja za koji želimo dobiti pripadajući zapis

Podatke o nazivima referentnih polja možemo dobiti info pozivom, pod ključem expandable.

// GET /document skupaj z expand.createdBy zaglavjem
// pridobimo zapis Document z id=2

{
  "id": 2,
  "created_by": 12,
  "createdBy": {
    // podatki povezanega zapisa User
    "id": 12,
    "first_name": "Janez",
    "last_name": "Novak"
  }
}

Poziv list-objects, s druge strane, vraća zapis koji je sačuvan u referentnom polju direktno — u ovom slučaju je pod referentnim poljem created_by sačuvan zapis modela User.

Korištenjem list-objects dobijamo iste podatke kao da smo pozvali /get za model referentnog polja, npr: api/user/view?id=12.

Budući da direktno dobijamo referentni zapis, na njemu možemo pozvati i zaglavlje expand.

// GET /list-objects?id=2&attribute=createdBy
// pridobimo zapis User z id=12

{
  "id": 12,
  "first_name": "Janez",
  "last_name": "Novak"
}

---

POST pozivi

info

Mnogi zapisi mogu imati polje u kojem je sačuvan zapis iz šifarnika iz drugog zapisa. Pogledajte referentno postavljanje polja.

Zaglavlja (Headeri)

Polje	Tip	Opis	Zadana vrijednost	Obavezno
Authorization	Bearer Token	Token za autentifikaciju		✔️
expand	string	Proširena polja
fields	string	Polja koja vraća zahtjev
href	boolean	Vraća URL pojedinačnog dokumenta	false
dateFormat	string	Formatira polja datuma i vremena	php:d.m.Y H:i:s
dateFields	string	Formatira samo određena polja
ignoreMissingReference	boolean	(true|false) Koristi se uz referentnom postavljanju polja	false
ignoreDuplicateReference	boolean	(true|false) Koristi se uz referentnom postavljanju polja	true
fillPlaceholders	boolean	Prilikom učitavanja .docx datoteka, automatski pokušava popuniti 'placeholder' polja.	false
removeUnfiledPlaceholders	boolean	Prilikom učitavanja .docx datoteka, skriva sva 'placeholder' polja koja nisu automatski popunjena.	false

Primjer

{
  "Authorization": "xfWuluzj...",
  "expand": "documentType.*,createdBy.name",
  "fields": "id,subject",
  "href": "true",
  "dateFormat": "php:d/m/Y",
  "dateFields": "created_at,updated_at",
  "ignoreMissingReference": "true",
  "ignoreDuplicateReference": "false",
  "fillPlaceholders": "false",
  "removeUnfiledPlaceholders": "false"
}

Kreiraj zapis

POST

https://{DOMAIN}/{CONTROLLER}/api/default/create

Opis

API poziv kreira novi zapis i vraća podatke o njemu.

---

Ažuriraj zapis

POST

https://{DOMAIN}/{CONTROLLER}/api/default/update?id={ID}

Opis

API poziv omogućava ažuriranje zapisa, ako korisnik ima pristup njemu. Kao odgovor se vraća zapis sa ažuriranim podacima.

---

DELETE pozivi

Zaglavlja (Headeri)

Polje	Tip	Opis	Zadana vrijednost	Obavezno
Authorization	Bearer Token	Token za autentifikaciju		✔️

Primjer

{
  "Authorization": "xfWuluzj..."
}

Obriši zapis

DELETE

https://{DOMAIN}/{CONTROLLER}/api/default/delete?id={ID}

Opis

API poziv briše određeni zapis, ako korisnik ima pristup njemu.

---

OPTIONS pozivi

Zaglavlja (Headeri)

Polje	Tip	Opis	Zadana vrijednost	Obavezno
Authorization	Bearer Token	Token za autentifikaciju		✔️

Primjer

{
  "Authorization": "xfWuluzj..."
}

Info zapisa

OPTIONS

https://{DOMAIN}/{CONTROLLER}/api/default/info

Opis

API poziv vraća detalje o zapisu.

// GET https://{DOMAIN}/document/api/default/info

{
    "modelClass": "mikrografija.mdocs.document.models.api.Document",
    "searchClass": "mikrografija.mdocs.document.models.search.DocumentSearch",
    "attributes": {
        "id": "ID",
        "principal_id": "Principal ID",
        "uuid": "UUID",
        "company_id": "Subjekt",
        "classification_code_id": "Klasifikacijski znak",
        "created_by": "Ustvaril",
        "updated_by": "Posodobil",
        ...
    },
    "expandable": {
        "principal": "principal.*",
        "company": "company.*",
        "classificationCode": "classificationCode.*",
        ...
    }
}

info

modelClass: puni naziv modela zapisa
searchClass: puni naziv modela za pretragu
attributes: tehnički i prikazni nazivi polja
expandable: referentna polja

---