API gakoak

API gako batek zure enpresako beste sistema bati —ERP bat, aginte-koadro bat, script bat— goPrevinan irakurtzen edo idazten uzten dio REST APIaren bidez, inoren kontua erabili gabe. Dei guztiak /api/v1 oinarrizko bidera doaz.

1. Zer dago pantailan

Goian, «Sortu gako bat» blokea «Izena» eremuarekin, «Esparruak» («Irakurketa», «Idazketa», «Analisiak (FHIR webhooka)» eta «Laneko osasun hornitzailea (bidalketa soilik)»), «Irismena» hautatzailea eta «Sortu gako bat» botoia. Azpian, «Baliabide bakoitzeko baimenak (API publikoa)» zabalgarria enpresaren gakoen zerrenda (bat ere ez badago, “Oraindik ez dago API gakorik.” dio) eta, amaieran, «Hornitzaileen bidalketak».

Gutxienez gako bat dagoenean, zerrendaren gainean lau egoera-txartel agertzen dira, kopuruarekin: “Iraungiak”, “30 egunean iraungitzen dira”, “Ezeztatuak” eta “Aktiboak”. Sakatu bat gako horiek soilik ikusteko; sakatu berriro denak ikusteko.

2. Gako bat sortzea

1. Idatzi nork erabiltzen duen esaten duen «Izena» (adibidez, “Nominen ERPa” edo “zuzendaritzaren aginte-koadroa”).

2. Markatu «Esparruak»: «Irakurketa» sistemak datuak kontsultatzen baditu bakarrik; gehitu «Idazketa» erregistroak sortu edo aldatu behar baditu bakarrik. «Analisiak (FHIR webhooka)» FHIR bidez emaitzak bidaltzen dituen laborategi batentzat soilik markatzen da. «Laneko osasun hornitzailea (bidalketa soilik)» Irlandako edo Erresuma Batuko lan-osasuneko edo screening-eko hornitzaile baten gakoarentzat da: gainerako esparruak ordezkatzen ditu eta irismena «Enpresa hau» izaten da. Horrekin hornitzaileak hitzorduak, gaitasun-emaitzak, ziurtagiriak eta screening-emaitzak (JSON, FHIR R4 edo audiometro eta espirometro CSV) bidaltzen ditu zure enpresara eta bere bidalketen kopuruak baino ez ditu irakurtzen, besterik ez.

3. «Irismena» eremuan aukeratu «Enpresa hau», «Taldeko enpresa guztiak» (kontuaren jabeak edo administratzaileak bakarrik) edo «SPAren bezero guztiak» (SPAren administratzaileak bakarrik).

4. Gakoak datu batzuk soilik ukitu behar baditu, ireki «Baliabide bakoitzeko baimenak (API publikoa)» eta markatu irakurketa edo idazketa baliabide bakoitzerako. «Irakurketa» eta «Idazketa» ez dira mediku-egokitasunera ez auditoria-erregistrora iristen: bakoitzak bere baimena behar du.

5. Sakatu «Sortu gako bat». “Kopiatu gako hau orain — ez da berriro erakutsiko:” agertzen da. Kopiatu, gorde erabiliko duen sisteman eta sakatu “Eginda”.

3. Txandakatu, ezeztatu eta erabilera zaindu

Zerrendako gako bakoitzak bere izena, esparruak, irismena (enpresa ez bada) eta “azken erabilera” erakusten ditu. “Txandakatu”-k balio berria sortzen dio gako berari (zaharra baliorik gabe geratzen da) eta behin bakarrik erakusten du. “Baliogabetu”-k “Baliogabetu API gakoa” berrespena irekitzen du: onartzean, gakoak berehala uzten du funtzionatzen eta ezin da desegin. Erabili sistema batek behar ez duenean edo ihes egin duela susmatzen baduzu.

Baliogabetutako edo iraungitako gakoa “baliogabetua” edo “iraungia” gisa markatzen da eta ez du botoirik. APIaren erabilera zure planaren kuotarekin alderatuta “Integrazioen monitorizazioa” pantailan ikusten da.

«Hornitzaileen bidalketak» atalak hornitzaile-gako bakoitzak bidali duena zerrendatzen du: hornitzailea (gakoaren izena), mota (hitzorduak, gaitasun-emaitzak, ziurtagiriak, screening-emaitzak, FHIR, audiometro edo espirometro CSV), “Onartuak”, “Errepikatuak” eta “Baztertuak” kopuruak eta jasotze-data. Kopuruak baino ez ditu erakusten, inoiz ez datu klinikorik.

4. Gako bat sistema bakoitzeko

Sortu gako desberdin bat konektatzen den sistema bakoitzerako: horrela, bat kentzen edo konprometitzen bada, haren gakoa bakarrik baliogabetzen duzu, besteek funtzionatzen jarraitzen dute, eta “azken erabilera”-n zein dagoen aktibo ikusten duzu. “30 egunean iraungitzen dira” txartelak denboraz berritu beharrekoak adierazten ditu.

Gakoak enpresaren datuetara sartzeko aukera ematen du emandako esparruekin: gorde erabiltzen duen sistemaren sekretu-kudeatzailean, inoiz ez posta elektroniko batean edo kalkulu-orri batean.