Fejlesztői dokumentáció

Mik azok a PlüssBarátok?

A PlüssBarátok olyan horgolt plüssfigurák, amelyekben linkeket tartalmazó NFC címkék vannak elhelyezve. E címkék segítségével a plüssök interaktívvá válnak és egy digitális profillal rendelkeznek. A felhasználók ezen a profilon láthatják a plüssük adatait (szülinap, fonalak, készítő, stb.), valamint el is nevezhetik őket.

Ehhez a digitális profilhoz bárki hozzáférhet az API-nkon keresztül, így bárki készíthet olyan alkalmazást vagy játékot, ami a PlüssBarátokkal kommunikál. Pl. telefonos játék, amelyben a felhasználó horgolt plüsse követi őt a játékban vagy egy mental health app, amiben a felhasználó saját kedvence ad motivációs idézeteket.

API kulcs kezelő NFC dokumentáció

PlüssBarátok API

API kulcs bejelentkezés után az API kulcs kezelő oldalon igényelhető. Az API kulcsok csak statisztikai célokra szolgálnak, így nem kell olyan szigorúan védeni őket.

Plüss adatainak lekérése

Hívás

GET /api/plushie/:urlEncodedNfcData Authorization: Bearer <api_key>

Példa hívás teszt adatokkal (az itt található API kulcs korlátozott ideig érvényes):

curl --location
            'https://plussbaratok.hu/api/plushie/https%3A%2F%2Fplussbaratok.hu%2Fplushie%2Fh6A8FukWYkpSfnDNN7Qi%3Fsource%3Dnfc'
            --header 'Authorization: Bearer
            81445dc1-e983-4518-bc31-677867d3ec61'

Figyelj, hogy az API hívásnál az NFC-ből kiolvasott URL-t URL-encode-olni kell. Próbáld ki itt.

Válasz

{
    "category": "animal" | "accessory" | "other",
    "createdAt": number,
    "iconHue": number,
    "iconUrl": string | null,
    "name": string,
    "state": "pending" | "active" | "lost",
    "type": AnimalName | string,
    "yarns": [
        {
            "brand": string, // pl. "Alize"
            "name": string, // pl. "Baby Best"
            "colorCode": number, // pl. 55
            "colorName": string, // pl. "Hóember"
            "colorHex": string, // pl. "#f3f3f3"
            "webshopUrl": string, // pl. "https://fonalam.hu/fonalak_79/alize-fonalak-251/alize-baby-best-batik-fonalak-439/alize-baby-best-fonal-250-vanilia-3001"
        }
    ],
}

category	Kategória.
createdAt	Készítés dátuma UNIX időbélyeg formátumban (milliszekundumban).
iconHue	Ha category == "animal", akkor a plüss ikon színárnyalata. Ez egy 0 és 360 közötti szám, amely a színkörön való helyzetét jelöli.
iconUrl	Az ikon URL-je. Ha category == "animal".
name	Név, amit a felhasználó adhat a plüssének.
state	Állapot: "pending" (készül), "active" (felhasználónál van), "lost" (elveszett).
type	Típus: pl. "cica", "axolotl", "sál", "kulcstartó", stb. Ez a horgoló által megadott típus.
yarns	A horgolásnál használt fonalak. Innen megtudhatod a plüss színeit is.