Kā atrast nepieciešamo Horizon REST resursu?

[#1]

Esat iegādājušies un uzstādījuši Horizon REST saskarni. Piedurknes ir atrotītas un esat gatavi ķerties pie integrācijas risinājuma izstrādes. Apsveicu!

Taču tagad sākas grūtākais (un interesantākais). Horizon ir apjomīga funkcionalitāte, kuras lielākā daļa ir pieejama REST saskarnē. Pamēģiniet REST saskarnes ieejas punktu: http://localhost:7378/rest (kur “localhost:7378” vietā ir jūsu aktuālā REST servera adrese un ports).

Rezultātā iegūsim daudzu tūkstošu rindiņu garu sarakstu.

Kā atrast un izvēlēties nepieciešamo resursu?

No REST saskarnes

Pieņemsim, ka vēlaties veikt salīdzinoši vienkāršu uzdevumu - nolasīt Horizon klientu sarakstu.

Ja mēģināsiet Horizon REST resursu sarakstā sameklēt “Klientu saraksts”, tad atradīsiet resursu, kas saucas “Klientu saraksts pamatdatos” (/rest/TDdmKlPamatDat). Vai tas ir vajadzīgais?

Te der atcerēties, ka viens no Horizon pamatjēdzieniem ir dokumentu pamatveids. Izliekam šo lauku Klientu sarakstā (skat. attēlu):

Redzam, ka dokumenta pamatveids saucas “Klienta kartīte”. Tagad varam meklēt pēc šīs frāzes Horizon REST resursu sarakstā un iegūstam saiti uz Klientu kartītes resursu:

    <link>
      <href>/rest/TDdmCustomer</href>
      <description>Klienta kartīte</description>
    </link>

Ejam uz šo resursu /rest/TDdmCustomer un sameklējam saiti uz Klienta kartītes kolekcijas resursu (meklējot pēc <href rel="collection">). Tas izskatās šādi:

  <link>
    <href rel="collection">/rest/TDdmKlSar</href>
    <description>Klientu izvēles saraksts</description>
  </link>

Rezultātā esam ieguvuši resursu darbam ar klientu sarakstu /rest/TDdmKlSar.

Bet kā tad paliek ar otru klientu sarakstu? Kuru no šiem izmantot?

Uz to nav viennozīmīga atbilde un tā ir atkarīga no konkrētās situācijas. Šajā gadījumā atšķirība ir tajā, ka /rest/TDdmKlSar satur arī darbinieku klienta kartītes (no Personāla moduļa), kamēr /rest/TDdmKlPamatDat tādas nerādīs. 

No HORIZON interfeisa

Lai atvieglotu datu atlases REST API resursu iegūšanu, 680.versijā Horizon izstrādāta iespēja, kas ļauj ātri un ērti iegūt precīzu saraksta REST API pieprasījuma saiti ar sarakstā fiksētu kolonnu izskatu un filtru.

Jebkurā saraksta logā, izvēlnē Darbības ir pieejama izvēlne "Saraksta API pieprasījums".

Šī darbība automātiski nolasa aktīvajā logā lietotāja uzstādīto filtru (izņemot dinamisko filtru) un izvēlētās izskata kolonnas, pārvēršot to gatavā REST URL tehniskajā struktūrā. Rezultātā sistēma izveido precīzu REST resursa adresi ar visiem nepieciešamajiem atlases filtriem un kolonnu nosaukumiem.

Šī izvēlne sarakstos pieejama lietotājiem, kuriem aktivizēts parametrs "Rādīt API URL iegūšanas izvēli saraksta darbībās" (Sistēma -> Uzstādījumi -> Kontroles un vides parametri -> Sistēma). Noklusēti lietotājiem šis parametrs nav aktivizēts.

!!! Jāņem vērā, ka REST API piekļuve ir nodrošināta ne visiem Horizon sarakstiem. 

[#2]

Integrācijām ar Horizon tiek izmantoti WEB lietotāji. Tas ir lietotāja paveids Horizon, ko izmanto pieslēgšanai WEB aplikācijām, t.sk. REST integrācijām.

Veidojot WEB lietotāju, tam obligāti jānorāda Horizon lietotājs, jo pēc šī Horizon lietotāja tiek noteikta WEB lietotāja loma un tiesības, kas nosaka pieejamās funkcionālās sadaļas un tiesības apstrādāt vai skatīt datus.

Tātad vispirms nepieciešams izveidot lomu ar atbilstošām pieejas tiesībām. Vairāk par lomu veidošanu lasīt šeit.

Sistēma - Administrēt - Lomas

Nākamais solis ir izveidot Horizon lietotāju.

Sistēma - Administrēt - Lietotāji

Šādam lietotājam norāda konta veidu Sistēmkonts.

Lappusē Tiesības norāda, kuras firmas datiem būs pieeja un ar kādu lomu.

Visbeidzot var veidot WEB lietotāju.

Sistēma - Administrēt - WEB lietotāji

Lappusa Pamatinformācija

Arī šeit konta veids jānorāda Sistēmkonts, kā arī WEB lietotājs jāsasaista ar Horizon lietotāju.

Lappusē Firmas un objekti norāda, kura šim pieslēgumam būs noklusētā firma.

Lappusē Atļautās saskarnes atzīmē "piešķirtās" un norāda saskarni "Vispārējā integrācija", ja vien nav izveidota atsevišķa saskarne topošajai integrācijai.

Vairāk par saskarnēm lasīt šeit.