API dokumentáció
A kulcsokat a Weboldalak és API kulcsok oldalon lehet létrehozni és visszavonni. A feltöltési API kulcs nélkül, vendégként is használható — lásd lentebb.
User API hitelesítés:
Authorization: Bearer YOUR_USER_API_KEY. A teljes kulcs csak létrehozáskor látható; bekapcsolt kétlépcsős azonosításnál új kulcs kizárólag az aktuális hatjegyű kóddal kérhető le a kulcskezelőben. A kérések és válaszok UTF-8 JSON-t használnak, kivéve a multipart képfeltöltést.User API – fiók és albumok
| Metódus | Végpont | Funkció | Mezők |
|---|---|---|---|
| GET | /api/v1/me | Aktuális felhasználó azonosítása | – |
| GET | /api/v1/albums | Saját albumok és feltöltéshez használható albumazonosítók | – |
| POST | /api/v1/albums | Album létrehozása | name, description, visibility: public/private |
| GET | /api/v1/albums/{album_id} | Egy album lekérése | – |
| PATCH/PUT | /api/v1/albums/{album_id} | Album módosítása | name, description, visibility |
| DELETE | /api/v1/albums/{album_id} | Album törlése | image_action: unassign vagy delete |
User API – képek
A User API-val feltöltött kép közvetlenül a felhasználóhoz és az opcionálisan megadott saját albumhoz kerül. Nem készül hozzá uploadedHash, és bármelyik, a GET /api/v1/albums válaszában szereplő albumba feltölthető.
| Metódus | Végpont | Funkció | Mezők / query |
|---|---|---|---|
| GET | /api/v1/images | Saját képek lapozott listája | page, limit (1–100), search, album_id, visibility, adult, deleted: active/with/only, sort: latest/oldest/views/size |
| POST | /api/v1/images | Kép feltöltése (multipart/form-data) | file kötelező; album_id, visibility: public/private/hidden, adult: true/false |
| GET | /api/v1/images/{image_id} | Kép, státusz, URL-ek, album és interakciók | – |
| PATCH/PUT | /api/v1/images/{image_id} | Láthatóság, felnőtt státusz vagy album módosítása | visibility, adult, album_id; üres értékkel kivehető az albumból |
| DELETE | /api/v1/images/{image_id} | Saját kép visszaállítható törlése | – |
| POST | /api/v1/images/{image_id}/restore | Törölt saját kép visszaállítása | – |
| POST | /api/v1/images/{image_id}/rotate-id | Új API-képazonosító; a régi érvénytelenné válik | – |
curl -X POST https://kephost.net/api/v1/images \
-H "Authorization: Bearer YOUR_USER_API_KEY" \
-F "file=@image.jpg" -F "album_id=ALBUM_ID_FROM_API" \
-F "visibility=private" -F "adult=false"
curl -H "Authorization: Bearer YOUR_USER_API_KEY" \
"https://kephost.net/api/v1/images?page=1&limit=24&deleted=with"User API – hozzászólások és értékelések
| Metódus | Végpont | Funkció / mező |
|---|---|---|
| GET / POST | /api/v1/images/{image_id}/comments | Lapozott lekérés (page, limit) vagy új hozzászólás: comment |
| PATCH/PUT | /api/v1/images/{image_id}/comments/{comment_id} | Saját hozzászólás módosítása: comment |
| DELETE | /api/v1/images/{image_id}/comments/{comment_id} | Hozzászólás törlése a saját képről |
| GET / PUT / DELETE | /api/v1/images/{image_id}/comments/{comment_id}/vote | Szavazat lekérése, mentése (vote: 1 vagy -1) vagy törlése |
| GET | /api/v1/images/{image_id}/rating | Lapozott értékelések, átlag és darabszám; query: page, limit |
| PUT / POST | /api/v1/images/{image_id}/rating | Saját értékelés létrehozása vagy cseréje: rating 1–5 |
| DELETE | /api/v1/images/{image_id}/rating | Saját értékelés törlése |
Weboldal / feltöltési API
Formátum: multipart/form-data. Kötelező: file. Opcionális: hash (weboldal API-kulcs), uploadedHash (hiányában automatikusan készül), gallery_id, private: yes/no/hidden, felnott: yes/no.
- Kulcs nélkül is használható. Ilyenkor a feltöltés vendégként történik: a kép mindig publikus lesz, és IP-címenként óránként legfeljebb 30 kép tölthető fel. Ugyanez a korlát vonatkozik a kezdőlapi feltöltésre is.
- Regisztrált tulajdonosú API-kulccsal bármely saját album használható, és a láthatóság szabadon választható; ezt a szerver ellenőrzi.
- Vendég tulajdonú kulcs csak a beállított alapalbumot használhatja.
- A fájlméret, fájltípus, tiltás, duplikátum, láthatóság és az óránkénti keret mind szerveroldalon érvényesül — a kliens által küldött értékek nem bírálhatják felül.
- A válasz URL-t, thumbnailt, adatlap- és letöltési linket, valamint
uploadedHashértéket tartalmaz; utóbbival törölhető a feltöltés.
| Metódus | Végpont | Funkció |
|---|---|---|
| POST | /api/v1/website/upload | Képfeltöltés kulccsal vagy kulcs nélkül |
| POST | /api/v1/website/images/delete | Egy kép törlése: apiKey, uploadedHash, image |
| POST | /api/v1/website/images/delete-all | A feltöltési csoport összes képének törlése: apiKey, uploadedHash |
| POST | /api/upload/hash | Új uploadedHash előkészítése; mező: hash |
| GET | /image/{uploadedHash} | A feltöltési csoport képes adatlapja |
| GET | /image/{uploadedHash}/thumbnail/{filename} | Egy kép thumbnailje |
Régi végpontok (csak kompatibilitás)
Az alábbiak továbbra is működnek, de új integrációhoz a fenti /api/v1/website/… útvonalakat használd. A régi címek változatlanul ugyanazt csinálják, csak nem kapnak új funkciókat.
| Régi végpont | Helyette |
|---|---|
POST /upload, POST /uploadImage.php | POST /api/v1/website/upload |
GET /removeImage.php?apiKey=…&uploadedHash=…&image=… | POST /api/v1/website/images/delete |
GET /removeAllImage.php?apiKey=…&uploadedHash=… | POST /api/v1/website/images/delete-all |
GET /viewImage.php?w=… | GET /image/{uploadedHash} |
Kódminták
Válaszd ki a műveletet és a nyelvet — a minta azonnal frissül. Bejelentkezve a saját API-kulcsod is behelyettesíthető.
Válaszok
// sikeres feltöltés
{"wrong": false, "data": [{"filename": "…", "url": "…", "thumbnail": "…",
"pageUrl": "…", "downloadLink": "…", "uploadedHash": "…", "i": 12345}]}
// sikeres törlés
{"wrong": false, "text": "…"} // delete-all esetén + "removed": 3
// hiba
{"wrong": true, "text": "…"}A weboldal API kulcs generálása, visszavonása, watermarkja és alapértelmezett albuma a weboldal/API beállításoknál érhető el.
HTTP hibák: 400 hibás kérés, 401 hibás User API kulcs, 403 korlátozás, 404 nem saját vagy nem létező erőforrás, 409 duplikátum, 413 túl nagy kép, 415 hibás képtípus, 422 mezőhiba, 500/503 szerver- vagy sémahiba.