Integraatiokäsikirja

Mikä on integraatiokäsikirja?

Integraatiokäsikirja on asiakkaan ja integraatiokehittäjien yhteinen työkalu, jossa määritellään tavat kehittää integraatioita ja API-rajapintoja. Se määrittelee yksiselitteisesti asiakkaan kanssa sovitut käytännöt ja kehityksen toimintamallit. Integraatiokäsikirja on juuri sinun organisaatiollesi tehty, ja se määrittelee teidän tapanne tehdä asioita. Erilaisista integraatiotavoista ja teknologioista, voit lukea lisää artikkelissamme Integraatiot - lyhyt oppimäärä.

"Integraatiokäsikirja sovitetaan aina asiakkaan tarpeisiin niin sisällön kuin laajuudenkin osalta."

Integraatiokäsikirjaa luotaessa HiQ:n konsultti haastattelee asiakasta heidän jo olemassa olevista käytännöistään, prosessista sekä palvelinympäristöistään. Asiakkaalta saadun tiedon perusteella konsultti kirjoittaa käsikirjan, jonka asiakas katselmoi. Asiakkaan kommenttien perusteella käsikirjaa muokataan iteratiivisesti, kunnes asiakas hyväksyy integraatiokäsikirjan. Tämän jälkeen käsikirjaa käytetään kaiken integraatiokehittämisen ohjenuorana ja oppaana.

Mitä integraatiokäsikirja sisältää?

Asiakaskohtaisten ohjeiden lisäksi tuomme integraatiokäsikirjaan ehdotuksemme seuraavista asioista:

• Nimeämiskäytännöt

• APIen julkaisu- ja jakelutavat

• Yleisohjeet erilaisten integraatiotapojen valintaan kuhunkin käyttötapaukseen

• Määrittelyjen tekeminen ja hallinta esimerkkeineen

• Luettelo ja sopimus asioista, jotka pitää olla määritelty ennen työn aloittamista (Definition -of-Ready)

• Luettelo ja sopimus asioista, mitkä pitää olla tehtynä, ennen kuin yksittäistä integraatiota voi kutsua valmiiksi ja luovuttaa asiakkaalle (Definition-or-Done)

• Dokumentointipaikka ja esimerkkipohjat

Integraatiokäsikirjan käyttö varmistaa integraatioratkaisuiden yhdenmukaiseen, hallittavuuden sekä ylläpidon helppouden. Koska integraatioalustan päälle kerääntyvät integraatioratkaisut ovat ylläpidettävä kokonaisuus itsessään, ovat laatu ja ylläpidettävyys avainasemassa.