Skava Skava / Wiki

Prilagođeni elementi: API

API interfejs je obrazac čije popunjene vrednosti Skava šalje kao JSON na adresu koju navedete (vaša pozadina). Na taj način možete bezbedno povezati Skavu sa vašim vlastitim sistemima.

i

Upravljate API interfejsima u Web aplikaciji pod Prilagođenim elementima → prebacite API interfejsi. Kreiranje i uređivanje su rezervisani za administratore tvrtke; objavljeni interfejsi se tada mogu aktivirati od svih članova tvrtke.

Postavi API interfejs

Interfejs se sastoji od polja unosa (oni formiraju JSON), ciljnu adresu, i autentifikaciju.

  1. Kreiraj polja: Svako polje dobija JSON ključ. Na desnoj strani vidite živ pregled JSON-a, koji se šalje vašoj pozadini tačno na ovaj način.
  2. Adresa (URL): https:// adresa vaše pozadine. Samo HTTPS i javno dostupne adrese su dozvoljene (vidite Sigurnost ispod).
  3. Metoda: POST (podrazumevano), PUT, PATCH, ili GET. Sa GET vrednosti se dodeljuju kao parametri upita umesto da se šalјu u telu.
  4. Autentifikacija: Postavite ime zaglavlja (npr. Authorization) i vrednost prefiksa (npr. Bearer ), pa čuvajte token. Po želji postavite datum isteka.
  5. Polja odgovora (opciono): Definirajte po putanji koje vrednosti iz odgovora pozadine trebaju biti prikazane — npr. order.id ili items[0].sku.
  6. Proverite sa Ping i Test zahtev, pa Objavite.

Čuvaj token bezbedno

Token je čuvan šifrovano i nikada se ne vraća klijentima — aplikacija samo pokazuje da li je token postavljen i kada ističe. Pri slanju, Skava ga dodeljuje server-side konfiguriranom zaglavlju. Ako postavite datum isteka, Skava odbija poziv nakon isteka i traži od vas da obnovite token.

Testiranje: Ping i Test zahtev

  • Ping — laka proveravost dostižnosti. Samo proverava da li vaša adresa odgovara, i ne šalje token ili podatke obrazca u procesu. Pokazuje dostižnost, status, i vreme odgovora. Idealno kao prvi korak.
  • Test zahtev — pravi probni proces: šalje uzorke podataka uključujući token na vašu adresu i pokazuje vam kompletan odgovor kao i izdvojena polja odgovora.

Kao admin, možete pokrenuti oba dok ste još u modu nacrta da proverite integraciju pre nego što objavite.

Nacrt i objavljivanje

Svaki interfejs počinje kao nacrt i može biti slobodno uređen. Kada je sve gotovo, objavljujete ga sa Objavite.

!

Objavljeni interfejsi su nepromenjivi. Ovo je namerno: tako da nakon objavljivanja nikako ne može tajno zamenjiti ciljnu adresu ili token. Ako želite da promenite nešto, napravite novu verziju.

Sigurnost

i

Da sprečite interfejs od zloupotrebe, stroga pravila se primenjuju: samo HTTPS adrese su dozvoljene, i adresa mora pokazati na javnu ciljnu adresu — unutrašnje adrese (npr. localhost, privatne mreže, ili metapodaci oblaka) su odbijeni. Skava proverava ovo na svakom pozovu, povezuje se tačno na verifikovanu adresu, ne sledi preusmeravanja, i ograničava vreme gašenja i veličinu odgovora.

Vezano

Želite li umesto toga da napravite popunjiv šablon dokumenta? Vidite Prilagođeni elementi: dokumenta.

Često postavljana pitanja

Šta je API interfejs u Skavi?

Obrazac čije popunjene vrednosti Skava šalje kao JSON na adresu koju navedete (vaša pozadina) — odličan za povezivanje Skave sa vašim vlastitim sistemima.

Ko sme da kreira i aktivira API interfejse?

Kreiranje i uređivanje su rezervisani za administratore tvrtke. Objavljeni interfejs se tada može aktivirati od svih članova tvrtke.

Koja je razlika između "Ping" i "Test zahtev"?

Ping samo proverava da li je adresa dostižna — bez tokena i bez podataka. Test zahtev šalje uzorke podataka uključujući token i pokazuje kompletan odgovor.

Je li moj API token siguran?

Da. Token je čuvan šifrovano i nikada se ne isporučuje klijentima. Aplikacija samo pokazuje da li je token postavljen i kada ističe.

Koje adrese su dozvoljene kao krajnje tačke?

Samo javno dostupne https:// adrese. Unutrašnje ciljne tačke kao localhost, privatne mreže, ili metapodaci oblaka su odbijeni — ovo sprečava zloupotrebe interfejsa.

Zašto više ne mogu menjati objavljeni interfejs?

Objavljeni interfejsi su namerno nepromenjivi — tako da nakon objavljivanja nikako ne može zamenjiti ciljnu adresu ili token. Za izmene, napravite novu verziju.