Skava Skava / Wiki

Elemente Personalizate: API

O interfață API este un formular ale cărui valori umplute Skava le trimite ca JSON la o adresă pe care o specifici (backend-ul tău). Aceasta îți permite să conectezi Skava în siguranță cu propriul tău sistem.

i

Gestionezi interfețe API în Webapp sub Elemente Personalizate → comută Interfețe API. Crearea și editarea sunt rezervate pentru admini de firmă; interfețele lansate pot fi apoi declanșate de toți membrii firmei.

Configurează o interfață API

O interfață constă din câmpuri de intrare (formează JSON-ul), adresa țintă și autentificare.

  1. Creează câmpuri: Fiecare câmp primește o cheie JSON. Pe dreapta vezi în direct previzualizarea JSON, care este trimisă la backend-ul tău exact în acest fel.
  2. Adresă (URL): adresa https:// a backend-ului tău. Sunt permise doar adrese HTTPS și accesibile public (vezi Securitate mai jos).
  3. Metodă: POST (implicit), PUT, PATCH sau GET. Cu GET valorile sunt anexate ca parametri de interogare în loc să fie trimise în corp.
  4. Autentificare: Stabilește numele antetului (de ex. Authorization) și prefix de valoare (de ex. Bearer ), apoi salvează jetonul. Opțional stabilește o dată de expirare.
  5. Câmpuri de răspuns (opțional): Definește după cale ce valori din răspunsul backend-ului ar trebui afișate — de ex. order.id sau items[0].sku.
  6. Verifică cu Ping și Cerere Test, apoi Lansare.

Stochează jetonul în siguranță

Jetonul este stocat criptat și niciodată nu se întoarce la clienți — aplicația arată doar dacă este setat un jeton și când expiră. La trimitere, Skava îl anexează server-side la antetul configurat. Dacă setezi o dată de expirare, Skava refuză apelul după expirare și te cere să reînnoiești jetonul.

Testare: Ping și Cerere Test

  • Ping — o verificare ușoară a accesibilității. Doar verifică dacă adresa ta răspunde și nu trimite jeton sau date de formular în proces. Arată accesibilitate, status și timp de răspuns. Ideal ca prim pas.
  • Cerere Test — tura adevărată: trimite date de eșantion incluzând jeton la adresa ta și îți arată răspunsul complet, precum și câmpurile de răspuns extrase.

Ca admin, poți rula ambele în timp ce ești încă în modul proiect pentru a verifica integrarea înainte de lansare.

Proiect și Lansare

Fiecare interfață începe ca proiect și poate fi editată liber. Odată ce totul este gata, o lansezi cu Lansare.

!

Interfețele lansate sunt imuabile. Aceasta este intenționată: pentru ca după lansare nimeni nu poate schimba în secret adresa țintă sau jetonul. Dacă vrei să schimbi ceva, creezi o versiune nouă.

Securitate

i

Pentru a preveni utilizarea greșită a interfeței, se aplică reguli stricte: sunt permise doar adrese HTTPS și adresa trebuie să indice la o adresă țintă publică — adrese interne (de ex. localhost, rețele private sau metadate cloud) sunt respinse. Skava verifică aceasta la fiecare apel, se conectează exact la adresa verificată, nu urmărește redirectări și limitează timeout și dimensiunea răspunsului.

Legat

Vrei să construiești în loc să construiești un șablon de document umplut? Vezi Elemente Personalizate: Documente.

Întrebări Frecvente

Ce este o interfață API în Skava?

Un formular ale cărui valori umplute Skava le trimite ca JSON la o adresă pe care o specifici (backend-ul tău) — util pentru conectarea Skava cu propriele tale sisteme.

Cine are voie să creeze și să declanșeze interfețe API?

Crearea și editarea sunt rezervate pentru admini de firmă. O interfață lansată poate fi apoi declanșată de toți membrii firmei.

Care este diferența dintre "Ping" și "Cerere Test"?

Ping doar verifică dacă adresa este accesibilă — fără jeton și fără date. Cerere Test trimite date de eșantion incluzând jeton și arată răspunsul complet.

Este jetonul meu API sigur?

Da. Jetonul este stocat criptat și niciodată nu se livra clienților. Aplicația arată doar dacă este setat un jeton și când expiră.

Ce adrese sunt permise ca puncte finale?

Doar adrese https:// accesibile public. țintele interne cum sunt localhost, rețele private sau metadate cloud sunt respinse — aceasta protejează împotriva utilizării greșite a interfeței.

De ce nu mai pot schimba o interfață lansată?

Interfețele lansate sunt intenționat imuabile — pentru ca după lansare nimeni nu poate schimba adresa țintă sau jetonul. Pentru schimbări, creezi o versiune nouă.