Što je API?
API je kratica za Application Programming Interface i označava softversko sučelje.
API pomaže u komunikaciji između programa, baš kao što si osoba pomaže pitanjima i odgovorima kada želi dobiti informacije. Ako koriste isti jezik (isti API), razumjet će se, ali inače im je potreban prevoditelj. Isto vrijedi i za informacijske sustave.
Ako dva sustava ne koriste isti standardni API, potreban im je prijevod. O tome se brinu profesionalci, koji se obično nazivaju integratori. Moraju proučiti specifičnosti oba API-ja i osigurati pravilan prijevod između njih.
Saop API trenutno podržava "XML" jezik, s "UTF-8 BOM" kodiranjem.
Tehnička dokumentacija: https://icwebsvc.saop.si/SI/API
Primjer Swaggerovog testnog okruženja: https://icwebsvc.saop.si/SI/API/swagger/ui/index
Neki uobičajeni primjeri upotrebe Saop API-ja
Kao korisnik, želim preuzimati ili snimati iz vanjske aplikacije nacrte izdanih računa u ERP-u, za potrebe izdavanja računa.
Vanjska aplikacija priprema podatke o pojedinačnom računu (klijent, datumi, artikl, količina, cijena) te ih pozivanjem odgovarajuće metode (AddInvoice) upisuje se u ERP. Dokument se preračunava u ERP i na temelju objaviti proces. Vanjska aplikacija također može čitati takav dokument s korištenjem metode GetInvoice. U slučaju da eksterna aplikacija želi promijeniti nacrt fakture, u tu se svrhu može koristiti metoda ModifyInvoice.
Kao korisnik želim od vanjske aplikacije u kojoj se pripremaju izdanja fakture (a također se izdaju), evidentiraju financijski događaj u ERP-u.
S obzirom da je račun izrađen i izdan u vanjskoj aplikaciji, u ERP pozivom metode prenosi samo financijski dnevnik AddJournal.
Kao korisnik vanjske aplikacije želim da se primljeni račun upiše u ERP s u svrhu daljnje obrade.
Primljeni račun dodaje se u ERP metodom AddIncomingInvoice. U slučaju ako primljeni račun ima jedan ili više priloga, samo se oni dodaju u dokumentaciju sustav s metodom AddDocument. U slučaju da je primljeni račun u obliku eRačun, može se koristiti jedan od elektroničkih kanala ePoštara.
Kao korisnik internet trgovine, želim izvršiti ili zabilježiti narudžbu u ERP za potrebe daljnje obrade (izdavanje robe, fakturiranje, financijsko računovodstvo).
Nalog se upisuje u ERP metodom AddOrder, ali prije toga potrebno je pribaviti matične, popratne i druge podatke i to:
Artikli : GetItems
Strankei: GetCustomer (ako stranka ne postoji, dodaje se s AddCustomer)
Zalihe: GetStock
Cijene: GetPrices
Nalog se, naravno, sve dok je u odgovarajućem statusu, također može promijeniti metodom ModifyOrder, ili se može dobiti u metodi GetOrder.
Kao korisnik WMS-a želim preuzeti prijavljenu robu.
U ERP-u se na temelju naloga dobavljača priprema prijedlog preuzimanja ili preuzimanje od dobavljača. Vanjski sustav, s metodom GetReceivingAdviceStatus provjerava je li neki dokument u statusu pogodan za preuzimanje. Ako takav dokument postoji, čita se metodom GetReceivingAdvice, a zatim upotrijebite metodu ModifyReceivingAdvice za unos takav status, koji onemogućuje promjenu dokumenta unutar ERP-a.
Kada se izvrši stvarni prijem u skladište, metoda ModifyReceivingAdvice uredi dokument u ERP-u i s metodom PostReceivingAdvice to materijalno knjiži.
Kao WMS korisnik želim preuzeti neprijavljenu robu.
Kada se izvrši stvarni prijem u skladište, metoda AddReceivingAdvice zapisuje dokument u ERP i koristi metodu PostReceivingAdvice materijalno proknjiži.
Kao korisnik vanjskog sustava želim evidentirati izdavanje robe u ERP.
U vanjskom sustavu kao što je WMS, roba se priprema za izdavanje kao također i pripadajući popratni dokument. Kada operacija u vanjskom sustavu kompletan, dokument se mora proslijediti u ERP.
Ovisno o vrsti izdavanja (najavljeno, otvoreno, narudžba) koristi se sljedeća metode:
- Najavljeno izdavanje: WMS priprema izdavanje na temelju primljene objave o izdavanju, pruža ERP. Kada se dovrše aktivnosti u ERP-u, metoda ModifyDispatchAdvice upisuje podatke o stvarno izdanim količinama u ERP.
- Otvoreno izdavanje: izdavanje se događa u WMS-u i budući da je aktivnost započela u ERP-u, dokument je napisan metodom AddDispatchAdvice.
- Narudžba: ERP prosljeđuje jednu ili više narudžbi u WMS. Na temelju izdane naredbe su pripremljene. Kada su aktivnosti u vanjskom sustavu, samo ovo zapisuje dokumente pomoću metode AddDispatchAdvice izdaje robu i zatim djelomično ili potpuno zatvara narudžbe.
U slučaju da jedna narudžba vrijedi za jedno izdavanje, vanjski sustav može metodom MoveOrderToDispatchAdvice pripremiti puštanje u ERP i onda samo to sa metoda PostDispatchAdvice proknjiži.