Template API V2

REST API

Ez a verzió csak REST API-n érhető el.

List assets

Visszaadja a rendszerben mentett, a sablonokban használható képek listáját.

REST API

Kérés

GET hammy/json/template/v2/assets

Paraméter	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
fileName	String	A keresett file neve.
type	String	A keresett file típusa.
category	String	A keresett file kategóriája.
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete (pl. resultSize = 10 és offset = 1, akkor a teljes találati lista 11. elemétől a 20. eleméig tartó listát adja vissza).
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JAsset2 [ ]	A megtalált képek.

KérésVálasz

GET /hammy/json/template/v2/assets?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "type": "assets",
            "id": "{{uuid}}",
            "attributes": {
                "fileName": "filename.png",
                "category": "Kategoria1",
                "mimeType": "image/png",
                "description": "desc_asset"
            }
        }
    ],
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show asset

Visszaadja a megadott azonosítójú sablonban használható képet.

REST API

REST API Info

Kérés

GET hammy/json/template/v2/assets/{{uuid}}

Név	Típus	Leírás
uuid	String	A keresett asset UUID-ja.

Válasz

Típus	Leírás
JAsset2	A keresett asset.

Minta

KérésVálasz

GET /hammy/json/template/v2/assets/{{uuid}}?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "assets",
        "id": "{{uuid}}",
        "attributes": {
             "fileName": "filename.png",
             "category": "Kategoria1",
             "mimeType": "image/png",
             "description": "desc_asset"
        }
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show asset content by UUID

Ebben a verzióban nem változott.

Show asset content by UUID V1

Create asset

Létrehoz egy sablonokban használható képet.

REST API

REST API Info

Kérés

POST hammy/json/template/v2/assets

A kérés egy multipart/form-data. Az asset nevű részben kell az asset json leíróját, az asset_data részben pedig az asset byte content-jét küldeni.

Multipart név	Tartalom	Leírás
asset	JAsset2	A létrehozandó asset adatai.
asset_data	application/octet-stream	Az asset tartalma.

Válasz

Típus	Leírás
JAsset2	A létrehozott asset.

Minta

KérésVálasz

POST /hammy/json/template/v2/assets?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
content-type: multipart/form-data; boundary={{boundary}}
-----------------------------{{boundary}}
Content-Disposition: form-data; name="asset"
Content-Type: application/json

{
    "data": {
            "id" : "{{uuid}}",
            "type": "assets",
            "attributes": {
                "fileName": "filename2.png",
                "category": "Kategoria1",
                "mimeType": "image/png",
                "description": "desc_asset 2"
            }
        }
}
{{boundary}}
Content-Disposition: form-data; name="asset_data"
Content-Type: application/octet-stream
[BINARY CONTENT]
{{boundary}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Authorization: JWT {{jwtToken}}
Transfer-Encoding: chunked

{
  "data" : {
    "type" : "assets",
    "id" : "{{uuid}}",
    "attributes" : {
      "fileName" : "filename2.png",
      "category" : "Kategoria1",
      "mimeType" : "image/png",
      "description" : "desc_asset 2"
    }
  },
  "meta" : {
    "total" : null,
    "params" : [ ],
    "responseStatus" : {
      "code" : 0,
      "messages" : [ ]
    }
  }
}