MagyarmagyarAz Amelia API: engedélyezés és hitelesítés
Hogyan kapcsolod be az API funkciót, hogyan generálsz API-kulcsot, és hogyan épül fel egy API-kérés.
Az API-n keresztül külső rendszerek biztonságos, strukturált kérésekkel tudnak kapcsolatba lépni az Amelia telepítéseddel. Így egyedi integrációkat építhetsz, szinkronizálhatsz adatokat, automatizálhatsz folyamatokat, és az Ameliát a beépített felületén túl is kibővítheted.
Az API funkció csak az Elite licencben érhető el. A használatához programozási ismeret kell, és a rendszeres támogatás nem terjed ki rá.
Hol kapcsolod be az API-t?
Szekció neve “Hol kapcsolod be az API-t?”- Nyisd meg az Amelia → Funkciók és integrációk oldalt, a Funkciók fület.
- Keresd meg az API kártyát (a Funkciók keresése mezőbe is beírhatod: „API”), és kapcsold be.
- A bekapcsolás után megjelenik a Beállítás gomb. Erre kattintva megnyílik a beállítóablak, ahol az API-kulcsokat generálhatod és kezelheted.
A képen az API alap-URL, a lejárati idő legördülő listája (itt 1 év), a Generálás gomb és az API-kulcsod mező látszik.
Mi látható a beállítóablakban?
Szekció neve “Mi látható a beállítóablakban?”| Elem | Mit csinál |
|---|---|
| API alap-URL | Az a végpontgyökér, amelyet minden API-hívásnak használnia kell. |
| Lejárati idő (legördülő lista) | Megadja, meddig érvényes az új kulcs: 1 év, 2 év, 3 év vagy korlátlan. |
| Generálás | Új API-kulcsot hoz létre a kiválasztott lejárati idővel. |
| API-kulcsod | A frissen létrehozott kulcsot mutatja. Mentés után a kulcs rejtve marad. |
| Kulcslista | A korábban létrehozott kulcsokat mutatja a lejáratukkal és a törlés gombbal. |
Az API-kulcsokat kizárólag ezen az oldalon kezelheted.
A kulcs csak egyszer látszik, a létrehozásakor. Másold ki azonnal, még a Mentés gomb megnyomása előtt, mert utána nem tudod újra megnézni.
Hogyan működnek az API-kulcsok?
Szekció neve “Hogyan működnek az API-kulcsok?”Az API-kulcs engedélyezi a hozzáférést az Amelia végpontjaihoz, és minden kérésben szerepelnie kell. Az összes végpont fejléc alapú hitelesítést használ: a kulcsot egy Amelia nevű fejlécben kell elküldeni.
A kulcs korlátozott vagy korlátlan érvényű lehet. A hozzáférés idejének szűkítésével nő a biztonság, ezért rövidebb lejáratot válassz, hacsak nincs szükséged tartós hozzáférésre.
Az API elérési útja
Szekció neve “Az API elérési útja”Minden kérés ezzel az alappal kezdődik:
{{az_oldalad_URL-je}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1Ehhez fűzöd hozzá a kívánt végpont útvonalát, például /users/customers. Egy teljes hívás így néz ki:
curl --location 'https://pelda.hu/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/users/customers' \--header 'Amelia: AZ_API_KULCSOD'Melyik végpont mire való?
Szekció neve “Melyik végpont mire való?”Az Amelia API a következő területekre ad végpontokat: időpontok, foglalások, fizetések, entitások, keresés, szabad időpontok, kuponok, kategóriák, szolgáltatások, helyszínek, egyéni mezők, statisztikák, csomagok, csomagvásárlások, extrák, erőforrások, események, munkavállalók, vásárlók, WordPress-felhasználók és értesítések. A következő fejezetek ezeket részletezik:
Készült: