Peldakodok/Értesítések REST

A iWiW Fejlesztői Wiki wikiből

Egy alkalmazás REST API-n keresztül is képes értesítést küldeni a felhasználóknak. Ez gadget-ek esetén 2 lábas OAuth autentikáción keresztül valósítható meg (a külső szolgáltatások REST-en keresztül történő értesítésküldésére itt találsz példát).

Példakód - PHP

PHP példakód REST-en történő értesítésküldésre 2 lábas OAuth autentikácóval a GitHubon

Hírlevélküldés esetén

Egy alkalmazásnak - előzetes egyeztetés után - lehetősége van userakció nélkül is értesítést küldeni a felhasználóinak. Ebben az esetben beszélünk "Hírlevélküldésről". Ennek a feltételeiről bővebben a blogon olvashatsz.

Az értesítés csak akkor lesz sikeresen elküldve (HTTP 200), ha a megadott xoauth_requestor_id-jú felhasználónak telepítve van az alkalmazás. Ellenkező esetben HTTP 504 error válasz érkezik. Mivel hírlevélküldés esetén csak olyan felhasználóknak küldhető értesítés, akiknek telepítve van az alkalmazás, xoauth_requestor_id-ként ugyanannak a user-nek az ID-ját add meg, akinek az értesítést küldöd (lásd a példakódban).

Mikor ér célba az értesítés?

Az elküldött értesítés nem fog megérkezni a címzetthez, ha az letiltotta az alkalmazások hozzáférését az adataihoz (API főkapcsoló) vagy ha nem engedélyezte az alkalmazásnak az értesítésküldést. Ezek vizsgálata azonban aszinkron módon történik, így ezen esetekben nem fogtok hibaüzenet kapni. Ha szeretnétek mérni, hogy hány felhasználót sikerült a kiküldött hírlevéllel aktivizálni, helyezzetek el egy paraméteres linke(ke)t az értesítés szövegében az alkalmazás canvas-ára, canvas-on pedig hozzatok létre egy számlálót, ami ezt a paramétert számolja.