API-integraation määrittely

Voit täyttää sen ilmaiseksi verkossa, se ei vaadi tiliä, ja sen voi ladata Word-asiakirjana tai PDF-tiedostona. Näytä kaikki IT ja projektit-mallit

• Integraation nimi

  Esimerkiksi: Kaupan tilaukset kirjanpitoon

• Asiakirjan versio

  Esimerkiksi: 1.0

• Laatinut

  Esimerkiksi: Hamza Idrissi

• Päivämäärä

  Esimerkiksi: 5. huhtikuuta 2029

• Tarkoitus

  Esimerkiksi: Lähetä jokainen maksettu verkkokaupan tilaus kirjanpitojärjestelmään myyntilaskuna, jotta taloushallinnon ei tarvitse kirjoittaa sitä uudelleen.

• Tietoja lähettävä järjestelmä

  Esimerkiksi: Verkkokauppa (API v2)

• Tietoja vastaanottava järjestelmä

  Esimerkiksi: Kirjanpitojärjestelmä (REST API)

• Tietovirta

  Esimerkiksi: 1. Asiakas maksaa tilauksen. 2. Kauppa lähettää webhookin integraatiopalvelulle. 3. Palvelu muuntaa tilauksen laskuksi ja kutsuu kirjanpidon API:a. 4. Kirjanpitojärjestelmä palauttaa laskun numeron, jonka palvelu tallentaa tilaukseen.

• Päätepisteet ja viestit

  Yksi rivi kutakin rajapintaa tai viestiä kohden.

  Esimerkiksi: POST /invoices | Luo lasku | Runko: asiakas, rivit, vero, loppusumma | Palauttaa: laskun id ja numero GET /customers?email= | Etsi asiakas | Palauttaa: asiakkaan id tai tyhjän POST /customers | Luo asiakas | Runko: nimi, sähköposti, osoite

• Kenttien yhdistäminen

  Mikä lähdejärjestelmän kenttä vastaa mitä kohdejärjestelmän kenttää. Kerro, miten arvot muunnetaan.

  Esimerkiksi: order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

• Todennus ja tietoturva

  Esimerkiksi: OAuth 2.0:n asiakastunnistetiedot. Tokenit ovat voimassa yhden tunnin. Salaisuudet säilytetään holvissa, ei koskaan koodissa. Kaikki kutsut käyttävät HTTPS:ää. Webhookit allekirjoitetaan ja allekirjoitus tarkistetaan.

• Virheet ja uudelleenyritykset

  Esimerkiksi: Yritä uudelleen 429- ja 5xx-virheissä enintään 5 kertaa kasvavin viivein. Älä yritä uudelleen 4xx-virheitä; kirjaa ne lokiin ja ilmoita taloushallinnolle. Jokaisella laskulla on yksilöllinen avain, jotta uudelleenyritys ei voi luoda kaksoiskappaletta.

• Rajat ja volyymit (valinnainen)valinnainen

  Esimerkiksi: Kirjanpidon API sallii 60 kutsua minuutissa. Odotettu määrä on 400 tilausta päivässä, alennusmyyntipäivinä jopa 2 000.

• Testaus

  Esimerkiksi: Käytä kirjanpidon testiympäristöä. Testaa normaali tilaus, alennuksellinen tilaus, hyvitys, jo olemassa oleva asiakas ja API-katkos.

• Omistajat ja tuki

  Esimerkiksi: Omistaja: verkkokauppatiimi. Tuki: Hamza Idrissi. Eskalointi: kirjanpitojärjestelmän toimittajan tukipalvelu.

• Muutokset ja versiointi (valinnainen)valinnainen

  Esimerkiksi: Kumpikin osapuoli ilmoittaa yhteensopimattomasta muutoksesta 30 päivää etukäteen.

1. 11. Tarkoitus
2. 22. Järjestelmät
3. 33. Tietovirta
4. 44. Päätepisteet ja viestit
5. 55. Kenttien yhdistäminen
6. 66. Todennus ja tietoturva
7. 77. Virheet ja uudelleenyritykset
8. 88. Rajat ja volyymit
9. 99. Testaus
10. 1010. Omistajat ja tuki
11. 1111. Muutokset ja versiointi

1. 01

   Täytä

   Kirjoita tietosi lomakkeeseen. Asiakirja täyttyy itsestään kirjoittaessasi. Napsauta mitä tahansa aukkoa, niin siirryt sen kenttään.

2. 02

   Tarkista

   Lue se läpi. Täyttämättömät aukot pysyvät merkittyinä, jotta mitään ei lähetetä puolivalmiina.

3. 03

   Lataa

   Tallenna se Word-asiakirjana, jos haluat muokata sitä lisää, tai PDF-tiedostona lähetettäväksi tai tulostettavaksi.

Mitä tietoja tämä pohja pyytää?

Lomake pyytää 16 tietoa, ensimmäisenä Integraation nimi, Asiakirjan versio, Laatinut, Päivämäärä, Tarkoitus. 2 muuta tietoa on valinnaista.

Voinko ladata tämän pohjan Word- tai PDF-tiedostona?

Kyllä. Kun olet täyttänyt lomakkeen, tallenna se Word-asiakirjaksi, jos haluat jatkaa muokkausta, tai PDF-tiedostoksi lähetettäväksi tai tulostettavaksi. Se on maksuton eikä vaadi tiliä.

Lähetetäänkö kirjoittamani tiedot jonnekin?

Ei. Kirjoittamasi tiedot pysyvät selaimessasi, kun täytät asiakirjaa. Ne menevät nerixille vain, jos valitset mallipohjan avaamisen chatissa.

Ovatko nämä IT- ja projektipohjat ilmaisia?

Useimmat ovat. Täytä ja lataa ne ilmaiseksi Word- tai PDF-muodossa ilman tiliä. Muutama pidempi asiakirja on premium: ilmainen täyttää, kertamaksu latauksesta ja hinta merkitty.

Tekeekö tietoturvakäytäntö meistä turvallisia?

Mikään asiakirja ei tee sitä yksin. Käytäntö auttaa, kun se vastaa sitä, mitä ihmiset oikeasti tekevät. Pidä se lyhyenä, selitä se tiimille ja tarkista se joka vuosi.

Onko projektin perustamisasiakirja vain suurille projekteille?

Ei. Pieni projektikin hyötyy, sillä yksi sivu, jossa on tavoite, rajat ja päättäjä, estää useimmat myöhemmät kiistat.

• Arkkitehtuuripäätöksen kirjausKirjaa tekninen päätös taustoineen, vaihtoehtoineen, perusteluineen ja seurauksineen, jotta tiimi löytää sen myöhemmin.IT ja projektit
• BYOD-käytäntöMääritä säännöt henkilökohtaisten puhelimien ja kannettavien tietokoneiden käytölle työssä: tietoturva, yksityisyys, tuki ja työsuhteen päättyminen.IT ja projektit
• VirheraporttiRaportoi ohjelmisto-ongelma, jotta kehittäjä voi toistaa sen, arvioida vaikutuksen ja korjata sen.IT ja projektit
• MuutoksenhallintasuunnitelmaSuunnittele, miten ihmisille tiedotetaan suuresta muutoksesta, miten heidät koulutetaan ja miten heitä tuetaan, sekä miten tiedät sen onnistuneen.IT ja projektit
• MuutospyyntöPyydä muutosta projektiin tai järjestelmään, näytä sen vaikutus ja kirjaa, onko se hyväksytty.IT ja projektit
• Tietoturvatietoisuuskoulutuksen kirjausSäilytä todiste siitä, että henkilöstö on koulutettu tietojenkalastelusta, salasanoista ja turvallisesta työskentelystä: aiheet, osallistuminen ja tulokset.IT ja projektit

Näytä kaikki IT ja projektit-mallit