MySklad API-gii ugu horreeyay wuxuu soo muuqday 10 sano ka hor. Wakhtigan oo dhan waxa aanu ka shaqaynaynay noocyada API-ga ee jira waxana aanu horumarinaynay kuwo cusub. Iyo dhowr nooc oo API ah ayaa horay loo aasay.
Maqaalkani wuxuu ka koobnaan doonaa waxyaabo badan: sida API loo abuuray, sababta adeegga daruurtu u baahan yahay, waxa ay siiso isticmaalayaasha, khaladaadkii aan ku guuleysanay inaan ku tallaabsano iyo waxa aan rabno inaan sameyno xiga.
Magacaygu waa Oleg Alekseev , Anigu waxaan ahay agaasimaha farsamada iyo aasaasaha MySklad.
Waa maxay sababta API loogu sameeyo adeeg
Macaamiishayada, kuwaas oo ah tobanaan kun oo ganacsato ah, waxay si firfircoon u isticmaalaan xalalka daruuraha: bangiyada, dukaamada internetka, xisaabinta badeecadaha, CRM. Marka aad mid ku xidho, way adagtahay in la joojiyo. Oo hadda adeegga shanaad, siddeedaad, tobnaad wuxuu ka dhigayaa shaqada ganacsadaha mid sahlan, laakiin isticmaalayaashu waxay ku wareejiyaan xogta u dhexeeya adeegyadan daruuraha si gacanta ah. Shaqadu waxay isu beddeshaa qarow.
Xalka muuqda waa in la siiyo dadka isticmaala awoodda ay ku gudbiyaan xogta u dhexeeya adeegyada daruuraha. Tusaale ahaan, soo dejinta iyo dhoofinta xogta sida faylal, kaas oo markaa lagu dhejin karo adeegga la rabo. Faylasha badanaa waa la beddelaa si ay ugu habboonaadaan qaabka adeeg kasta. Tani waa wax ka badan ama ka yar shaqada gacanta, laakiin kororka tirada adeegyadan, way sii adkaanaysaa in la fuliyo.
Sidaa darteed, tallaabada xigta waa API. Iyada oo leh, adeegga daruurtu waxay ka faa'iideysanayaan xaqiiqda ah in ay isku xirto dhowr adeegyo hal mar. Soo bixitaanka nidaamka deegaanka ee noocan oo kale ah ayaa soo jiidata macaamiisha cusub sababtoo ah fursado dheeraad ah. Alaabta leh shaqeyn cusub waxay noqotaa faa'iido badan oo faa'iido leh.
Haddii aad abuurto is-dhexgal barnaamijeed kuu gaar ah, tani waxay soo jiidanaysaa dadka iibka ah ee qolo saddexaad oo qaab barnaamij-sameeyayaal ka yaqaana alaabtaada mahad API-ga. Waxay bilaabaan inay dhisaan xalal ku salaysan API-ga la soo jeediyay oo ay lacag ku sameeyaan iyagoo otomaatig u ah hawlaha macaamiishooda.
Nidaamka xisaabinta MySklad wuxuu ku salaysan yahay habab fudud. Waxa ugu muhiimsan waa in la shaqeeyo dukumiintiyada aasaasiga ah, awoodda aqbalaadda iyo rarida alaabta, iyo helitaanka warbixinnada ganacsiga ee ku salaysan dukumentiyada aasaasiga ah. Waxa kale oo jira wareejinta xogta, tusaale ahaan xisaabaadka daruuraha, iyo rasiidhka laga helo nidaamyada bangiyada ama xarumaha tafaariiqda. Waxaan sidoo kale la shaqeynaa dukaamada online-ka ah: waxaan helnaa macluumaadka ku saabsan alaabta waxaanan u dirnaa macluumaadka ku saabsan baaqyada.
API-gii ugu horreeyay ee MySklad
In ka badan 10kii sano ee MySklad ee la shaqeynayey API, waxaan helnay dhammaan noocyada isdhexgalka ee noo ogolaanaya inaan bedelno xogta, la shaqeyno bangiyada, lacag bixinta iyo isticmaalka telefanka dibadda.
Sannadkii ugu horreeyay, waxaan suurtogal ka dhignay in la soo dejiyo xog kasta oo qaab XML ah. Waagaas, aad bay u caddahay oo aad bay caan u ahayd isticmaalayaashu inay xogta ku hayaan khadka, oo aanay ku jirin daruuraha qaarkood, waananu siinay iyaga. Soo raritaanka waxa lagu bilaabay dhoofinta gacanta ee is dhexgalka. Taasi waa, wali lama magacaabi karo API.
Isla mar ahaantaana, waxaan bilownay inaan la shaqeyno shirkadda Rusagro - waxay horeyba u isticmaali jireen ERP "dadka waaweyn" ee wax soo saarka iyo qorsheynta iibka, laakiin waxay si otomaatig ah u rareen gawaarida warshadaha MySklad. Tani waa sida aan ku helnay asalka ugu horreeya ee API-ga dhabta ah: isweydaarsiga u dhexeeya adeeggayaga iyo ERP ayaa dhacay annaga oo soo diraya fayl weyn oo xog ah dhammaan noocyada dukumentiyada.
Tani waa ikhtiyaar wanaagsan oo loogu talagalay isweydaarsiga xogta dufcada, laakiin ay weheliso dukumentiyada waxaan ku qasbanahay inaan wareejinno ku tiirsanaanta: macluumaadka ku saabsan alaabta, qandaraaslayaasha iyo bakhaarada. Qashin-qubka noocan oo kale ah ma aha mid aad u adag in la soo saaro marka la dhoofinayo, laakiin aad ayey u adag tahay in la kala saaro marka la soo dejinayo, maadaama dhammaan macluumaadka ay ku jiraan hal xirmo: labadaba dukumentiyada cusub iyo kuwa hadda jira.
API-gii ugu horreeyay ee XML ma noolaan muddo dheer - laba sano ka dib waxaan bilownay dib-u-dhiskeeda. Xitaa bilawga shaqadeeda, waxaanu samaynay khaladaad dhowr ah markii la dhisayay interface interface.
Sida XML API loo sameeyay: sawirka mid ka mid ah naqshadeeyayaashayada. Dhanka kale, la soco maqaalladiisa.
Waa kuwan khaladaadkeenna ugu waaweyn:
- Astaanta JAXB waxaa si toos ah loogu sameeyay digirta cidda. Waxaan u isticmaalnaa Hibernate si aan ula xiriirno xogta xogta, iyo calaamadaynta JAXB waxaa loo sameeyay digir isku mid ah. Ciladani waxay soo muuqatay isla markiiba: casriyeyn kasta oo ku saabsan qaab dhismeedka xogta ayaa horseeday baahida loo qabo in si degdeg ah loo ogeysiiyo qof kasta oo isticmaala API, ama in la dhiso biraha kuwaas oo hubin doona inay la jaanqaadaan qaab dhismeedka xogta hore.
- API-gu wuxuu u koray sidii wax-ku-dar-is-bar-bar-ku-dhigeed, oo annagu markii hore ma aannu qeexin qaybta ay alaabtu tahay. Xitaa kama ay fikirin in API uu yahay shay muhiim ah, haddii ay lagama maarmaan tahay in la ilaaliyo iswaafajinta dib u noqoshada macaamiisheeda ugu horreeya. Hal mar, tirada isticmaalayaasha API waxay ahayd qiyaastii 5% tirada yar, wax dareen ah lama siin iyaga. Shaandhaynta caalamiga ah ee la sameeyay hal mar ayaa keentay in naloo isticmaalo sidii dhabarka dambe. Shaandhayntani gabi ahaanba ma ahayn GraphQL, laakiin wax la mid ah - waxay ka shaqeysay xaddi badan oo xargaha su'aalaha. Qalabkan awoodda badan leh, way ku adkeyd in isticmaalayaashu ay iska caabiyaan, codsiyadana waa naloo soo wareejiyay si ay si toos ah uga soo diraan UI ee dukaamada online-ka ah. Xaaladdu waxay ahayd lama filaan aan fiicneyn, sababtoo ah bixinta adeeggan oo kale waa inay u baahan tahay qiime kala duwan iyo faham guud oo kala duwan oo API ah laftiisa sida badeecada.
- Sababo la xiriira xaqiiqda ah in API-ga aan loo horumarin sida badeecada ugu muhiimsan, dukumeenti API ayaa la soo saaray oo lagu daabacay ku salaysan hadhaaga - iyada oo loo marayo injineernimada. Jidkani wuxuu u muuqdaa mid sahlan oo habboon, laakiin waxay ka soo horjeedaa ku shaqeynta qandaraaska. Tani waa marka ay jirto qayb gaar ah oo leh nidaamka hawlgalka ee la sii dajiyay. Horumariyuhu wuxuu u fuliyaa si waafaqsan nidaamkan iyo hawshan, qaybta waa la tijaabiyay, macmiilkuna wuxuu helayaa badeecad ku habboon fikradda falanqeeyaha. Injineerinka roga ayaa suuqa ku soo tuura badeecad si fudud u jirta: leh biro, xalal qariib ah iyo baaskiilo halkii ay ka isticmaali lahaayeen shaqada lagama maarmaanka ah.
- Dhammaan codsiyada codsiyada ee ku yimid API-ga waxaa loo falanqeyn karaa wax aan ka badnayn Nginx ama log server-ka codsiga. Tani nama ogolayn in aan aqoonsano meelaha mawduucyada, marka laga reebo laga yaabee isticmaalayaasha iyo macaamiisha. Haddii aysan jirin hab lagu maamulo codsiga ama diiwaangelinta macmiilka, waxay noqotaa mid aan suurtagal ahayn in la falanqeeyo xaaladda. Dhibaatadani waxay lahayd saamaynta ugu yar ee horumarinta API; waxay ku saabsan tahay fahamka ku habboonaanta iyo shaqeynteeda.
Isku dayga nambarka labaad: REST API
2010, waxaan isku daynay inaan dhisno nidaamka sarrifka lacagaha oo leh xisaabinta internetka - BukhSoft. Ma qaadin. Laakiin inta lagu guda jiro habka isdhexgalka, API buuxa ayaa soo muuqday: adeegga sarrifka REST, halkaas oo aysan jirin wax xorriyad ah sida helitaanka hawlgallada qaab wicitaannada RPC. Dhammaan isgaarsiinta API-ga waxaa la keenay habka caadiga ah ee nasashada: khadka weydiinta waxaa ku jira magaca cidda, iyo qalliinka lagu sameeyay waxaa lagu qeexay habka http. Waxaan ku darnay shaandhayn ku salaysan markii hay'adaha la cusboonaysiiyay, isticmaalayaashu hadda waxay haystaan fursad ay ku dhisaan ku-noqoshada nidaamyadooda.
Isla sanadkaas, API-ga dejinta bakhaarrada iyo hadhaaga alaabada ayaa soo muuqday. Qaybaha ugu qiimaha badan ee nidaamka ayaa noqday mid ay heli karaan isticmaalayaasha API-isweydaarsiga dukumeentiyada aasaasiga ah iyo xogta xisaabinta ee dheelitirka iyo qiimaha alaabta.
Bishii Disembar 2015, RetailCRM waxay daabacday maktabadda qolo saddexaad ee ugu horreysa si ay u gasho API-gayada. Waxaa la bilaabay in si firfircoon loo isticmaalo, iyadoo caannimada adeegga guud ahaan ay kortay, culeyska API-ga ayaa ka koray si ka dhaqso badan culeyska shabakadda shabakadda. Maalin maalmaha ka mid ah korriintii waxay isu beddeshay culays badan.
Boodkan, oo uu tilmaamayo fallaadha bidix, ayaa gabi ahaanba la yaabay server-ka u adeegaya API-gayaga. Waxa aanu ku qaadanay hal todobaad in aanu ogaano waxa dhabta ah ee keenaya culayskan. Waxaa soo baxday in kuwani ay yihiin codsiyo isku mid ah oo loo soo gudbiyay API-ga xagga hore ee macmiilka. Ilaa 50 macaamiil ah ayaa wax walba cunay. Markaas ayay ahayd markii aan ogaanay mid ka mid ah khaladaadkeena - xad la'aan buuxda.
Natiijo ahaan, waxaan soo bandhignay xaddid tirada codsiyada isku mar ah. Hadda waa suurtogal in aan wax ka badan laba codsi isku mar ka furan hal akoon. Tani waxay ku filan tahay in ay ku shaqeyso qaabka ku celcelinta xogta beddelka ee qaabka dufcadda. Iyo kuwa rabey in ay noo isticmaalaan sidii dhabarka, laga bilaabo wakhtigaas, waxaa lagu qasbay in ay si fiican u hoggaansamaan canshuuraha, tan iyo markii ay soo bandhigeen shaqada xisaabaadka dhowr ah software-kooda.
Aan u kala hormarno
Horeba tan iyo 2014, baahida API ee hadda jirta waxay noqotay qayb muhiim ah oo ka mid ah ganacsiga, API-ga laftiisa ayaa soo saara mugga ugu weyn ee xogta isweydaarsiga xogta macaamiisha. 2015, waxaan bilownay mashruuc lagu nadiifinayo API-ga. Waxaan u dooranay JSON bedelkii XML qaab ahaan waxaana bilownay inaan dhisno iyadoo ku saleysan sifooyinka la aqoonsaday intii lagu jiray hirgelinta nuqulkii hore:
- Awoodda maaraynta noocyada Nooc-noqoshada waxay kuu ogolaanaysaa inaad horumariso nooc cusub adiga oo aan saamaynaynin arjiga jira ama aan carqaladayn khibrada isticmaalaha.
- Awoodda isticmaalaha si uu u arko xogta badan ee jawaabta lafteeda ee uu helayo.
- Awoodda isdhaafsiga dukumentiyada waaweyn. Haddii aan ka shaqeyno dukumeenti ka badan 4-5 kun oo jagooyin, tani waxay dhibaato ku noqotaa server-ka: macaamil dheer, codsi dheer oo http ah. Waxaan dhisnay hab gaar ah oo kuu ogolaanaya inaad cusboonaysiiso dukumeenti qaybo ah oo aad maamusho boosaska gaarka ah ee dukumeentigan adigoo u diraya server-ka.
- Aaladaha ku celcelinta ayaa sidoo kale ku jiray nuqulkii hore.
- Xadka rarka ayaa la mid ah dhaxalkii raaga ee lagu talaabsaday noocii hore. Waxaan soo bandhignay xaddidaad tirada codsiyada muddo wakhti ah, tirada codsiyada barbar socda iyo codsiyada hal ciwaan IP ah.
Tan iyo markaas, waxaan sii deynay laba nooc oo yaryar oo API ah waxaanan bilownay dhowr API-yo gaar ah, laakiin habka guud ayaa ahaa mid aan isbeddelin. Qaabka sarrifka ee la cusboonaysiiyay iyo qaab dhismeedka cusub ayaa suurtageliyay in si degdeg ah loo saxo cilladaha API-ga.
MySklad API maanta
Maanta, MySklad API wuxuu xalliyaa dhibaatooyin badan:
- isweydaarsiga xogta ee dukaamada online-ka ah, nidaamyada xisaabaadka, bangiyada;
- helitaanka xogta iyo warbixinnada la xisaabiyay;
- u isticmaal sida dhabarka codsiyada macmiilka - codsiyadayada moobilka iyo diiwaanka lacagta caddaanka ah ee miiska shaqada iyada oo loo marayo API
- dirista ogeysiisyada ku saabsan isbeddelada xogta ee MySklad - webhooks;
- telefoonka;
- nidaamyada daacadnimada.
Iyada oo ku saleysan API, maamulahayaga Askar Rakhimberdiev afar saacadood gudahood waxaan ku qoray bot telegram oo soo jiidaya hadhaaga API-ga:
Hadda tirooyinka qallalan.
Waa kuwan tirakoobyadayada API-gii hore ee REST:
- 400 oo shirkadood;
- 600 isticmaalayaasha;
- 2 milyan oo codsi maalintii;
- 200 GB/maalintii taraafikada baxaya.
Oo waa kan waxa aan ula nimid dhammaan APIs-yada MySklad:
- in ka badan 70 is-dhexgal (qaar ka mid ah ayaa laga arki karaa halkan );
- 8500 oo shirkadood;
- 12 isticmaalayaasha;
- 46 milyan oo codsi maalintii;
- 2 TB/maalintii gaadiidka baxayay.
Maxaa ku xiga
Qorshayaasha horumarinta API ayaa ku socda dood firfircoon. Waxaan isku dayeynaa inaan ku xisaabtano khibradda hawlgelinta ee isticmaalayaashu na siiyaan. Had iyo jeer suurtagal maaha in wax walba la sameeyo hal mar, laakiin nooca cusub ee API ayaa ku dhow geeska oo leh xog badan oo ku habboon iyo qaab-dhismeed yar, OAuth si loo xaqiijiyo, iyo API-ga codsiyada lagu dhisay interface-ka.
Waxaad kala socon kartaa wararka ku jira degel gaar ah oo loogu talagalay horumarinta isku dhafka MySklad: .
Source: www.habr.com
