Brilliancy of quality
Arhitektuur

JSON API mobiili- ja välisrakendustele

Sapphire I.C.D.S.

Integratsioon ei tohiks sõltuda veebilehe märgendusest

Ettevõtteplatvorm ei ole enam eraldatud veebisait, kui sellega ühendatakse mobiilirakendus, juhi töökoht, siseportaal, terminal või partneriteenus. HTML-lehtede kasutamine tekitab kiiresti hapra kujundussõltuvuse. Otsene andmebaasipääs on veel ohtlikum: väline klient hakkab dubleerima ärireegleid, eirama õigusi ja sõltuma sisemisest salvestusskeemist.

Sapphire I.C.D.S. pakub selleks eraldi HTTPS JSON API integratsioonikeskkonda. See võtab vastu struktureeritud päringuid, tagastab masinloetavaid vastuseid, ei renderda kasutajalehti ega nõua kliendilt serveriandmebaasi tundmist. Avalik Roadmap fikseerib selle natiivsete klientide ja äriintegratsioonide avaldatud alusena.

JSON on vahetusvorming, mitte kogu arhitektuur

JSON üksi ei tee integratsiooni töökindlaks. Tähtis on, kes määrab käsu, kuidas kasutajat kontrollitakse ja kus toimub ärivalideerimine. Süsteemi API vastutab autentimise eest, moodulid avaldavad valdkonnakäsud eraldi lepingu kaudu. Klient annab toimingu ja andmed, server valib mooduli, kontrollib päringut ja koostab tulemuse.

Nii saavad veebiliides, mobiilirakendus ja välissüsteem kasutada sama valdkonnaloogikat. Tarne tulemuse salvestamine peab kontrollima marsruuti, müügikohta, toodet ja täitja õigusi sõltumata saatnud ekraanist. Klient vastutab kasutusliidese, moodul protsessi korrektsuse eest.

Seanssi ja identiteeti kontrollib server

API toetab seansi põhitsüklit: sisselogimist, kinnitatud kasutaja päringut, juurdepääsu uuendamist ja väljalogimist. Klient saab lühiajalise juurdepääsutokeni ja eraldi uuendustokeni. Uuendamine asendab paari, seega peab rakendus uued väärtused atomaarse toiminguna salvestama ega tohi edukat uuendust vana väärtusega korrata.

JSON-i kasutaja-, grupi- või objektiväljad ei tõenda volitusi. Server tuletab identiteedi kinnitatud seansist ja määrab seejärel andmeulatuse. Logistikamoodul ei tohi näidata teist marsruuti kliendi antud võõra juhiidentifikaatori tõttu; ärirühm seotakse serveris.

Moodulid avaldavad ainult selged toimingud

API ei ava automaatselt kõiki Sapphire I.C.D.S.-i funktsioone. Moodul peab rakendama API-pakkuja ja loetlema käsud. Nii saab integratsiooni väljastada etapiti: esmalt ohutu lugemine, siis kitsad muudatused ja pärast kontrolli keerukamad töövood. Välislepinguta moodul ei muutu paigaldamise tõttu kättesaadavaks.

Olekut muutvad käsud peavad kasutama muutmiseks mõeldud päringuid. Server tagastab mõistetavad tulemuskoodid vigase päringu, aegunud seansi, keelatud juurdepääsu, vale meetodi või ajutiselt puuduva sõltuvuse korral. Klient saab määratud käsitlustee, mitte HTML-vealehe.

  • Mobiiliklient saadab ainult vajalikud andmed ja hoiab tokeneid seadme kaitstud salves.
  • API-keskkond kontrollib seanssi, meetodit ja lubatud sisendimahtu.
  • Moodul kontrollib valdkonnareegleid, kasutaja ulatust ja olekusiirdeid.
  • Andmebaas jääb serverikihi taha ega ole kliendile otse avaldatud.

Sobivad äristsenaariumid

JSON API on kasulik väljaspool keskset back-office'i: logistikas määratud marsruudid, müügikoha andmed, tarnitud kogus, tagastus või dokumendi olek; arvestuses teatmik ja kinnitatud toiming; välisrakenduses lubatud oleku lugemine ja konkreetse käsu käivitamine brauserit jäljendamata.

Roadmap nimetab logistikat, arvestust ja välitööd loomulikeks suundadeks. See ei tähenda universaalset endpoint'i igale stsenaariumile. Valmiduse määrab paigaldatud mooduli käsukomplekt; projekt vajab toimingute, andmete, rollide ja versioonide maatriksit.

JSON API ei ole väline MCP

JSON API teenindab ette kavandatud töövooga mobiili- ja ettevõtterakendusi. Väline MCP on tööriistu avastavate AI-klientide jaoks. Nende õigusi ja avaldamist ei saa samastada.

API ei ole kaug-SQL-konsool, suvaliste aruannete generaator ega lubadus pääseda kõikidesse tabelitesse. See pakub mooduli vastutusalasse kuuluvaid ärikäske, mis on skeemimuutustele vastupidavam ja pikaajaliselt ohutum abstraktsioon.

Kliendirakenduse kohustused

Natiivne klient peab käsitlema tokeni aegumist ja asendamist, väljalogimist, võrgu kadumist ning kordussaatmist. Muudatuse puhul tuleb eristada kinnitatud keeldumist ebaselgest transporditulemusest. Ilma kokkulepitud idempotentsuseta ei tohi võimalikku serveris täidetud toimingut automaatselt korrata. Kohalik vahemälu ei ole kehtivate õiguste allikas.

Tehniline meeskond määrab ka lepingute versioonimise, logimise, päringupiirangud ja tagasiühilduvuse. Platvorm annab ühise modulaarse keskkonna, konkreetse mobiilitoote kvaliteet sõltub kliendi distsipliinist ja ärilepingu täielikkusest.

Kasutuselevõtu tee

Töö algab kasutajastsenaariumidest, mitte tabeliloendist. Iga sammu jaoks fikseeritakse sisend, vastus, roll, andmeulatus, lubatud siirded ja korduskäitumine. Moodul avaldab minimaalse käsukomplekti, mobiilimeeskond ehitab liidese ja ühised testid katavad lubatud ning keelatud juhud.

Ettevõte saab arendada oma rakendusi serveriloogikat dubleerimata. Tehniline juht saab ühise autentimise ja modulaarsete käskudega juhitud integratsioonipiiri. JSON API laiendab Sapphire I.C.D.S.-i veebiliidesest kaugemale, hoides andmed, õigused ja protsessireeglid autoriteetses serverikeskkonnas.