Fejlesztői dokumentáció

Shortcuts és x-callback-url

Automatizáld az átviteli sebesség ellenőrzéseket, a végpont-validálást és az eredmények gyűjtését beépített műveletekkel és visszahívási végpontokkal.

Áttekintés

Az iPerf3 Client & Server két automatizálási réteget tesz elérhetővé:

Natív Apple Shortcuts műveletek (legtöbb felhasználónak ajánlott)
x-callback-url végpontok szkriptelhető alkalmazásközi munkafolyamatokhoz

Alap URL-séma

Használd az iperf3cs://x-callback-url/... sémát visszahívás-alapú automatizáláshoz.

Kompatibilitás

Az aktuális Apple platformkövetelmények: iOS/iPadOS 16.6+, macOS 13.5+ és visionOS 1.0+.

Beépített Shortcuts műveletek

Ezek a műveletek közvetlenül elérhetők az Apple Shortcuts alkalmazásban:

iPerf teszt futtatása

Tesztet futtat konfigurálható szerverrel, protokollal, iránnyal és időzítéssel. A shortcuts folyamatban a tipikus alapértelmezett időtartam 5 másodperc.

Utolsó eredmény lekérése

Visszaadja a helyi előzményekből a legutóbbi befejezett eredményt.

Szerver tesztelése

Ellenőrzi a végpont elérhetőségét egy teljes futtatás előtt.

Szerverek listázása

Visszaadja a konfigurált szervereket menüvezérelt automatizáláshoz.

x-callback-url végpontok

GETiperf3cs://x-callback-url/run-test

Új tesztet indít és opcionálisan visszatér visszahívási URL-eken keresztül.

Paraméter	Típus	Kötelező	Leírás
`server`	String	Igen	Az iPerf3 végpont hosztneve vagy IP-je.
`protocol`	String	Nem	`tcp` (alapértelmezett) vagy `udp`.
`direction`	String	Nem	`download`, `upload` vagy `bidirectional`.
`durationSec`	Integer	Nem	Időtartam másodpercben. Az automatizálásban a tipikus alapértelmezett érték 5.
`streams`	Integer	Nem	Párhuzamos adatfolyamok száma.
`x-success`	String	Nem	Visszahívási URL a sikeres eredmény hasznos adataihoz.
`x-error`	String	Nem	Visszahívási URL a hiba hasznos adataihoz.

GETiperf3cs://x-callback-url/get-last-result

Visszaadja a legutóbbi helyi eredményt, hasznos időszakos naplózási munkafolyamatokhoz.

Paraméter	Típus	Kötelező	Leírás
`x-success`	String	Nem	Visszahívási URL a sikeres hasznos adatokhoz.
`x-error`	String	Nem	Visszahívási URL a hibákhoz.

GETiperf3cs://x-callback-url/test-server

Ellenőrzi a végpont elérhetőségét és visszaadja az állapot/késleltetés metaadatait.

Paraméter	Típus	Kötelező	Leírás
`server`	String	Igen	Tesztelendő hosztnév vagy IP.
`port`	Integer	Nem	Port értéke (alapértelmezett: 5201).

Példák

Teszt futtatása visszahívásokkal

 iperf3cs://x-callback-url/run-test?server=iperf.example.com&protocol=tcp&direction=download&durationSec=8&x-success=shortcuts://run-shortcut?name=StoreResult 

Legutóbbi eredmény olvasása

 iperf3cs://x-callback-url/get-last-result?x-success=shortcuts://run-shortcut?name=PushSummary 

Terminálindítás macOS-en

 open "iperf3cs://x-callback-url/run-test?server=10.0.1.5&protocol=udp&direction=bidirectional&durationSec=5" 

Tipikus hasznosadat-mezők

 {
  "testId": "A8B3D9",
  "timestamp": "2026-02-26T09:42:10Z",
  "server": "iperf.example.com",
  "protocol": "tcp",
  "downloadMbps": 942.7,
  "uploadMbps": 876.4,
  "status": "completed"
} 

Hibakezelés

Ha egy művelet sikertelen és az x-error jelen van, a visszahívás egy hibaobjektumot kap.

Kód	Leírás
ERR_CONNECTION_FAILED	Nem sikerült csatlakozni a végponthoz.
ERR_TIMEOUT	A csatlakozás vagy a teszt túllépte az időkorlátot.
ERR_INVALID_SERVER	Hibás formátumú hoszt vagy elérhetetlen cím.
ERR_NO_RESULTS	Nincs mentett eredmény a kért művelethez.
ERR_INVALID_PARAMS	Hiányzó vagy érvénytelen kötelező paraméterek.

 {
  "errorCode": "ERR_CONNECTION_FAILED",
  "errorMessage": "Could not reach iperf.example.com:5201"
} 

GYIK

Miért nem tér vissza a visszahívás a Shortcuts alkalmazásba?

Győződj meg arról, hogy a visszahívási URL-ek URL-kódoltak és a séma engedélyezett az eszközödön. Kerüld a szóközöket vagy a kódolatlan szimbólumokat a lekérdezési értékekben.

Tudnak a tesztek teljesen a háttérben futni?

A megbízható végrehajtáshoz tartsd az alkalmazást aktívan a teszt futása alatt. Használj Shortcuts ütemezést a futtatások meghatározott időpontokban való indításához.

Mi a legbiztonságosabb integrációs minta?

Használd először a test-server végpontot, majd csak akkor futtass átviteli tesztet, ha a végpont-ellenőrzés sikeres.

Vissza a főoldalra Alkalmazás letöltése