Ուղղորդիչ:  Առաջին մակարդակ Վեբ-սերվիս (API)

Ընդհանուր նկարագրություն

 

Այս բաժնում նկարագրված է ՀԾ-Հաշվապահ 7 համակարգի հետ տվյալների փոխանակման համար ծրագրային ինտերֆեյսը (API - Application Programming Interface):

Ծրագրային ինտերֆեյսը (API) օգտագործվում է այլ ինֆորմացիոն համակարգերի հետ համակցման համար:

Բաժինը հասցեագրված է ինֆորմացիոն համակարգեր մշակողների ծրագրավորողին: Ենթադրվում է, որ ընթերցողը ծանոթ է ՀԾ-Հաշվապահ 7 համակարգի աշխատանքի սկզբունքներին:

 

SOAP պրոտոկոլ
 

Ծրագրային ինտերֆեյսը (API) հիմնված է SOAP (Simple Object Access Protocol) պրոտոկոլի վրա:

Փոխազդեցությունն ապահովելու համար կիրառվում է.

•XML - նշագրման ընդլայնված լեզու, որը նախատեսված է կառուցվածքային տվյալների պահպանման և փոխանցման համար,

•SOAP - XML բազայի վրա հաղորդագրությունների փոխանակման պրոտոկոլ,

•WSDL -  XML բազայի վրա Վեբ-սերվիս արտաքին ինտերֆեյսերի նկարագրման լեզու:

Վեբ-սերվիսը նկարագրվում է գործողությունների փաթեթով: Յուրաքանչյուր գործողություն կարող է ունենալ որոշակի քանակությամբ պարամետրեր` Վեբ-սերվիսին տվյալներր փոխանցելու և վերադարձված արժեքները ստանալու համար:

Վեբ-սերվիսն ապահովում է.

•համակարգի տվյալների պահոցից տեղեկատվական և հաշվետվական ինֆորմացիայի տրամադրում, օրինակ` որոշակի պահեստում առկա ապրանքների ցուցակի ստացում, ապրանքների քանակները և գները:

•համակարգի փաստաթղթերի և տեղեկատուների էլեմենտների գրանցում և ընթերցում, օրինակ` նոր ապրանքի գրանցում կամ վաճառքի փաստաթղթի գրանցում:

 

Ծրագրավորման գրադարաներ
 

Գոյություն ունեն գրադարաններ, որոնք իրականացնում են SOAP պրոտոկոլը: 

Դրանցից մի քանիսը թվարկված են ստորև.

•PHP - nuSOAP և SOAPClient,

•Python - suds,

•Perl - SOAP::Lite և XML::Compile:

 

SOAP-ի գրադարաններից շատերն օգտագործում են WSDL նկարագրերը՝ վեբ-սերվիսին ուղարկվող հարցումները կազմելու և փոխանցվող տվյալները ստուգելու համար: Գրադարանները ներբեռնում են WSDL նկարագիրը, վերլուծում և ձևավորում են տվյալների կառուցվածքները, որոնք անհրաժեշտ են մեթոդները կանչելու համար: Ծրագրին մնում է լրացնել կառուցվածքները տվյալներով և կատարել հարցումը: Պատասխան XML հաղորդագրությունից ստացված տեղեկատվությունը վերադարձվում է ծրագրավորման լեզվին բնորոշ կառուցվածքի տեսքով:

 
Վեբ-սերվիսի հրապարակում

Վեբ-սերվիսը այլ սպառողներին հասանելի դարձնելու համար` կատարվում է Վեբ-սերվիսի հրապարակում: Վեբ-սերվիսը պետք է հրապարակված լինի Internet Information Services (IIS) վեբ-սերվերի վրա:

 

Վեբ-սերվիսին հասանելիության հղման հասցե.
http://{server_name:port_number}/{publish_name}/AccountantService.svc?wsdl.

 

Անվտանգության համար Վեբ-սերվիսի հրապարակումը ցանկալի է SSL-ի միջոցով:
https://{server_name:port_number}/{publish_name}/AccountantService.svc?wsdl.

 

Օգտագործողի նույնականացումը Վեբ-սերվիսին դիմելիս
 

Նախքան վեբ-սերվիսի մեթոդներին դիմելը` անհրաժեշտ է ստանալ միացման նույնացուցիչ: Նույնացուցիչը ստանալու համար անհրաժեշտ է կիրառել StartSession մեթոդը:

Նույնականացումը կատարվում է ՀԾ-Հաշվապահ 7 համակարգի միջոցներով. Օգտագործող (User) և Գաղտնաբառ (Password):

Եթե Օգտագործող (User) և Գաղտնաբառ (Password) պարամետրերը նշված են ճիշտ, ապա վերադարձվում է միացման նույնացուցիչ, որի կյանքի տևողությունը 120 րոպե է:

Միացման նույնացուցիչը օգտագործվում է վեբ-սերվիսի բոլոր հարցումներում (մեթոդներում) որպես առաջին պարամետր:

 

Սխալների մասին հաղորդագրություններ

 

Սխալի առաջացման դեպքում հարցման մշակումը ընդհատվում է և վերադարձվում է սխալի մասին հաղորդագրություն SOAP fault ֆորմատով: 

faultcode տարրը պարունակում է սխալի կոդ, faultstring տարը սխալի նկարագրություն: