Was ist eine API-Schnittstelle in Skava?

Ein Formular, dessen ausgefüllte Werte Skava als JSON an eine von dir hinterlegte https://-Adresse (dein Backend) sendet — praktisch, um Skava mit eigenen Systemen zu verbinden.

Wer darf API-Schnittstellen anlegen und auslösen?

Anlegen und Bearbeiten ist Firmen-Admins vorbehalten. Eine freigegebene Schnittstelle können anschließend alle Mitglieder der Firma auslösen.

Was ist der Unterschied zwischen „Ping“ und „Test-Request“?

Ping prüft nur, ob die Adresse erreichbar ist — ohne Token und ohne Daten. Test-Request sendet Beispieldaten inklusive Token und zeigt die vollständige Antwort.

Ist mein API-Token sicher?

Ja. Der Token wird verschlüsselt gespeichert und nie an Clients ausgeliefert. Die App zeigt nur, ob ein Token gesetzt ist und wann er abläuft.

Welche Adressen sind als Endpunkt erlaubt?

Nur öffentlich erreichbare https://-Adressen. Interne Ziele wie localhost, private Netze oder Cloud-Metadaten werden abgelehnt — das schützt vor Missbrauch der Schnittstelle.

Warum kann ich eine freigegebene Schnittstelle nicht mehr ändern?

Freigegebene Schnittstellen sind bewusst unveränderlich — so kann nach der Freigabe niemand mehr Zieladresse oder Token austauschen. Für Änderungen legst du eine neue Version an.

Mukautetut elementit: API

API-rajapinta on lomake, jonka täyttämät arvot Skava lähettää JSON-muodossa osoitteeseen, jonka määrität (omalle palvelinelle). Näin voit yhdistää Skavan turvallisesti omiin järjestelmiin.

Hallitset API-rajapintoja Webappissa Mukautetut elementit -kohdassa → käännä API-rajapinnat. Luominen ja muokkaaminen on varattu yrityksen ylläpitäjille; vapautetut rajapinnat voivat sitten käynnistää kaikki yrityksen jäsenet.

API-rajapinnan asettaminen

Rajapinta koostuu syöttökentistä (muodostavat JSON-muotoisen), kohdeosoitteesta ja todentamisesta.

Luo kentät: Jokainen kenttä saa JSON-avaimen. Oikealla näet elävän JSON-esikatselun, joka lähetetään palvelimeesi juuri näin.
Osoite (URL): palvelimesi https:// osoite. Vain HTTPS ja julkisesti käytettävissä olevat osoitteet ovat sallittuja (katso turvallisuus alla).
Menetelmä: POST (oletusarvo), PUT, PATCH tai GET. GET:n kanssa arvot lisätään kyselyparametreiksi rungon sijaan.
Todentaminen: Aseta otsikon nimi (esim. Authorization) ja arvon etuliite (esim. Bearer ), sitten tallenna tunnus. Halutessaan aseta vanhentumispäivä.
Vastausarvot (valinnainen): Määritä polulla, mitkä palvelimen vastauksen arvot pitäisi näyttää — esim. order.id tai items[0].sku.
Tarkista Lähetysyritys ja Testipyyntö -painikkeilla, sitten Vapauta.

Tallenna tunnus turvallisesti

Tunnus tallennetaan salattuna eikä koskaan palauteta asiakkaille — sovellus näyttää vain onko tunnus asetettu ja milloin se vanhenee. Lähetyksen yhteydessä Skava liittää sen palvelimen puolella määritettyyn otsikkoon. Jos asetat vanhentumispäivän, Skava kieltäytyy puhelusta vanhentumisen jälkeen ja pyytää sinua uusimaan tunnuksen.

Testaus: Lähetysyritys ja testipyyntö

Lähetysyritys — kevyt tavoitettavuuden tarkistus. Se tarkistaa vain vastaako osoitteesi eikä lähetä tunnusta tai lomakkeen tietoja prosessissa. Näyttää tavoitettavuuden, tilan ja vastausajan. Ihanteellinen ensimmäisenä vaiheena.
Testipyyntö — todellinen koe: lähettää näytetiedot tunnus mukaan lukien osoitteeseen ja näyttää sinulle täydellisen vastauksen sekä poimitut vastauskentät.

Ylläpitäjänä voit suorittaa molemmat vielä luonnos-tilassa varmistaaksesi integraation ennen vapauttamista.

Luonnos ja vapautus

Jokainen rajapinta alkaa luonnoksena ja voidaan muokata vapaasti. Kun kaikki on valmis, vapautat sen Vapauta -painikkeella.

Vapautetut rajapinnat ovat muuttumattomia. Tämä on tarkoituksellista: jotta vapautuksen jälkeen kukaan ei voi salaa vaihtaa kohdeosoitetta tai tunnusta. Jos haluat muuttaa jotain, luo uusi versio.

Turvallisuus

Jotta rajapintaa ei väärinkäytettäisi, tiukat säännöt ovat voimassa: vain HTTPS-osoitteet ovat sallittuja ja osoitteen tulee osoittaa julkiselle kohdeosoitteelle — sisäiset osoitteet (esim. localhost, yksityiset verkot tai pilven metatiedot) hylätään. Skava tarkistaa tämän jokaisella puhelulla, yhdistää täsmälleen vahvistettuun osoitteeseen, ei seuraa uudelleenohjauksia ja rajoittaa aikakatkaisua sekä vastauskokoa.

Liittyvät

Haluatko rakentaa täytettävän asiakirjamalliin sen sijaan? Katso Mukautetut elementit: asiakirjat.

Usein kysytyt kysymykset

Mikä on API-rajapinta Skavassa?

Lomake, jonka täyttämät arvot Skava lähettää JSON-muodossa osoitteeseen, jonka määrität (omalle palvelinelle) — kätevä Skavan yhdistämiseen omiin järjestelmiin.

Kuka saa luoda ja käynnistää API-rajapintoja?

Luominen ja muokkaaminen on varattu yrityksen ylläpitäjille. Vapautetun rajapinnan voi sitten käynnistää kaikki yrityksen jäsenet.

Mitä eroa on "Lähetysyrityksellä" ja "Testipyynnöllä"?

Lähetysyritys tarkistaa vain osoitteen tavoitettavuuden — ilman tunnusta ja ilman tietoja. Testipyyntö lähettää näytetiedot tunnus mukaan lukien ja näyttää täydellisen vastauksen.

Onko API-tunnus turvassa?

Kyllä. Tunnus tallennetaan salattuna eikä koskaan toimitetaan asiakkaille. Sovellus näyttää vain onko tunnus asetettu ja milloin se vanhenee.

Mitkä osoitteet ovat sallittuja päätepisteinä?

Vain julkisesti saatavissa olevat https:// osoitteet. Sisäiset kohteet kuten localhost, yksityiset verkot tai pilven metatiedot hylätään — tämä suojaa rajapintaa väärinkäytöltä.

Miksi en voi enää muuttaa vapautettua rajapintaa?

Vapautetut rajapinnat ovat tarkoituksella muuttumattomia — jotta vapautuksen jälkeen kukaan ei voi vaihtaa kohdeosoitetta tai tunnusta. Muutoksille luot uuden version.