Erőforrások dokumentációja

Autentikáció ellenőrzése

- Request:

GET /whoami/

Nem igényel plusz adatokat

- Response:

A sikeresen autentikált felhasználó főbb adatait adja vissza. Sikertelen autentikáció esetén 401-es HTTP kódot ad.

HTTP 200
{
    “id” : “{USERID}”,
    “login” : “{USERNAME}”,
    “email” : “{USEREMAIL}”
}

Esemény rögzítése

- Request:

POST /event/hu.findgore.com/{EVENTTYPE}/

Request body:

Egy mező sem kötelező, azonban a rendszer tudásának kihasználásához a következő 3 mezőt érdemes küldeni:

{
    “email” : “{EMAIL}”,
    “uuid” : “{UUID}”,
    “url” : “{URL}”
}

hu.findgore.com : A domain, amihez az eseményt be kell rögzíteni

{EVENTTYPE} : Az esemény típusa, az angol abc kisbetűit és _ karaktert tartalmazhat

{EMAIL} : A küldő oldalon belépett felhasználó e-mail címe

{UUID} : A küldő oldalon belépett felhasználó egyedi findgore azonosítója.

Amennyiben a findgore track.js kódja van bekötve, akkor a ‘findgore-id’ nevű süti értékét kell küldeni.

Amennyiben a contking feedbak.js kódja van bekötve, akkor a ‘contking-id’ nevű süti értékét kell küldeni.

Amennyiben ezek közül egyik sincs bekötve, akkor a felhasználónak generálni kell egy egyedi azonosítót, és azzal küldeni mindig az eseményeket, de ebben az esetben a rendszer nem képes a felhasználó oldalon belüli böngészési viselkedését elemezni.

{URL} : az az url, amin az esemény történt, nem muszáj küldeni, ha minden esemény csak egy konkrét url-en következhet be, vagy ha nincs szükség az események eloszlásának statisztikájára.

- Response:

HTTP 200

{
    “error” : []
}

Hibalehetőségek:

• Nem POST metódussal van meghívva:

405-ös HTTP kódot ad

• Nem létezik a domain és nem is sikerült létrehozni:

410-es HTTP kódot ad, és a következő választ:

{
    “error” : {
        102 : “Domain not found”
    }
}

• Nem létezik a subdomain és nem is sikerült létrehozni (feltéve, hogy subdomain van megadva):

410-es HTTP kódot ad, és a következő választ:

{
    “error” : {
        103 : “Subdomain not found”
    }
}

• Nem létezik az esemény típus és nem is sikerült létrehozni:

410-es HTTP kódot ad, és a következő választ:

{
    “error” : {
        104 : “Event type not found”
    }
}