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.

Elementi personalizzati: API

Un'interfaccia API è un modulo i cui valori compilati Skava invia come JSON a un indirizzo da te specificato (il tuo backend). In questo modo puoi connettere Skava in modo sicuro con i tuoi sistemi.

Gestisci le interfacce API nella Webapp sotto Elementi personalizzati → attiva Interfacce API. La creazione e la modifica sono riservate agli amministratori aziendali; le interfacce rilasciate possono quindi essere attivate da tutti i membri dell'azienda.

Configura un'interfaccia API

Un'interfaccia è costituita da campi di input (formano il JSON), l'indirizzo di destinazione e l'autenticazione.

Crea campi: ogni campo ottiene una chiave JSON. A destra vedi dal vivo l'anteprima JSON, che viene inviata al tuo backend esattamente in questo modo.
Indirizzo (URL): l'indirizzo https:// del tuo backend. Solo gli indirizzi HTTPS e pubblicamente accessibili sono consentiti (vedi Sicurezza di seguito).
Metodo: POST (predefinito), PUT, PATCH o GET. Con GET i valori vengono aggiunti come parametri di query invece di essere inviati nel corpo.
Autenticazione: imposta il nome dell'intestazione (ad esempio Autorizzazione) e il prefisso del valore (ad esempio Bearer ), quindi salva il token. Facoltativamente imposta una data di scadenza.
Campi di risposta (facoltativo): definisci per percorso quali valori dalla risposta del backend dovrebbero essere visualizzati — ad esempio order.id o items[0].sku.
Controlla con Ping e Richiesta di test, quindi Rilascia.

Archivia il token in modo sicuro

Il token viene archiviato crittografato e mai restituito ai client — l'app mostra solo se un token è impostato e quando scade. Durante l'invio, Skava lo aggiunge lato server all'intestazione configurata. Se imposti una data di scadenza, Skava rifiuta la chiamata dopo la scadenza e ti chiede di rinnovare il token.

Test: ping e richiesta di test

Ping — un controllo leggero di raggiungibilità. Controlla solo se il tuo indirizzo risponde e non invia token o dati del modulo nel processo. Mostra la raggiungibilità, lo stato e il tempo di risposta. Ideale come primo passo.
Richiesta di test — la vera prova: invia dati di esempio incluso token al tuo indirizzo e ti mostra la risposta completa nonché i campi di risposta estratti.

Come amministratore, puoi eseguire entrambi mentre sei ancora in modalità bozza per verificare l'integrazione prima della versione.

Bozza e rilascio

Ogni interfaccia inizia come una bozza e può essere modificata liberamente. Quando tutto è pronto, la rilasci con Rilascia.

Le interfacce rilasciate sono immutabili. Questo è intenzionale: in modo che dopo il rilascio nessuno possa scambiare segretamente l'indirizzo di destinazione o il token. Se desideri modificare qualcosa, crea una nuova versione.

Sicurezza

Per prevenire l'uso improprio dell'interfaccia, si applicano regole rigorose: sono consentiti solo indirizzi HTTPS e l'indirizzo deve puntare a un indirizzo di destinazione pubblico — gli indirizzi interni (ad esempio localhost, reti private o metadata cloud) vengono rifiutati. Skava controlla questo ad ogni chiamata, si connette esattamente all'indirizzo verificato, non segue reindirizzamenti e limita il timeout e la dimensione della risposta.

Correlati

Desideri invece creare un modello di documento compilabile? Vedi Elementi personalizzati: documenti.

Domande frequenti

Che cos'è un'interfaccia API in Skava?

Un modulo i cui valori compilati Skava invia come JSON a un indirizzo da te specificato (il tuo backend) — pratico per connettere Skava con i tuoi sistemi.

Chi è autorizzato a creare e attivare le interfacce API?

La creazione e la modifica sono riservate agli amministratori aziendali. Un'interfaccia rilasciata può quindi essere attivata da tutti i membri dell'azienda.

Qual è la differenza tra "Ping" e "Richiesta di test"?

Ping controlla solo se l'indirizzo è raggiungibile — senza token e senza dati. Richiesta di test invia dati di esempio incluso token e mostra la risposta completa.

Il mio token API è sicuro?

Sì. Il token viene archiviato crittografato e mai consegnato ai client. L'app mostra solo se un token è impostato e quando scade.

Quali indirizzi sono consentiti come endpoint?

Solo indirizzi pubblicamente accessibili https://. Le destinazioni interne come localhost, reti private o metadata cloud vengono rifiutate — questo protegge dall'abuso dell'interfaccia.

Perché non riesco più a modificare un'interfaccia rilasciata?

Le interfacce rilasciate sono intenzionalmente immutabili — in modo che dopo il rilascio nessuno possa scambiare l'indirizzo di destinazione o il token. Per le modifiche, crea una nuova versione.