Biblioteka medija

Biblioteka medija čuva slike, video snimke i dokumente vaše aplikacije, svaki na javnom URL-u. Proizvodi, varijante, prodajne lokacije i stranice upućuju na te URL-ove. Ovim endpointima nalazite fajlove, držite ih uređenim, menjate fajl novom verzijom a da mesta koja ga koriste ne prestanu da rade, i raščišćavate.

Kako biblioteka radi#

• Fajl ima ključ i URL. Ključ je putanja fajla u skladištu vaše aplikacije, na primer 12-34/products/dog-food.jpg; URL je adresa sa koje svako može da ga preuzme. Oba ostaju ista dok fajl postoji.
• Folderi su za vas. folder fajla je mesto gde je složen u biblioteci. Premeštanje ili preimenovanje menja samo to, nikad ključ ni URL, pa ništa što ga koristi ne prestaje da radi.
• Slike se obrađuju posle otpremanja. Po pravilu otpremanja vaše aplikacije slike se kompresuju, često prebacuju u WebP i smanjuju u manje kopije koje zovemo renditions, svaku sa sopstvenim URL-om. To radi u pozadini ubrzo posle otpremanja, pa se width, height, size i renditions popunjavaju kasnije. Prebačen fajl zadržava originalnu ekstenziju u ključu.
• Skriveni fajlovi se drže van uobičajenog prikaza biblioteke, na primer skenovi koje kupci otpremaju iz aplikacije. Liste ih izostavljaju osim ako ih ne tražite.
• Brisanje ide u dva koraka. Obrisan fajl ide u korpu i njegov URL i dalje radi. Trajno brisanje ga uklanja zauvek. Fajlovi koji ostanu u korpi trajno se brišu sami posle 30 dana, osim ako je vaša aplikacija drugačije podešena.
• Upotreba se prati. Gde god je URL fajla sačuvan, na proizvodu, varijanti, prodajnoj lokaciji ili stranici, mi to beležimo, pa vidite na šta bi izmena uticala.

Objekat fajla#

Ono što endpointi za liste vraćaju za svaki fajl.

Pregled fajlova#

curl -G "https://api.morffeus.com/api/v2/cdn/files" \
  -H "Authorization: Bearer $MORFFEUS_TOKEN" \
  -d "folder=products" -d "kind=image" \
  -d "noalt=true" -d "pageSize=50"

{
  "data": {
    "files": [
      {
        "id": 7731,
        "filename": "dog-food.jpg",
        "key": "12-34/products/dog-food.jpg",
        "url": "https://cdn.example.com/12-34/products/dog-food.jpg",
        "folder": "products",
        "size": 84210,
        "mime": "image/webp",
        "width": 1600,
        "height": 1600,
        "alt": null,
        "tags": [],
        "version": 1,
        "usage_count": 2,
        "hidden": false,
        "renditions": [
          {
            "label": "w800",
            "width": 800,
            "height": 800,
            "url": "https://cdn.example.com/12-34/products/[email protected]",
            …
          }
        ],
        …
      }
    ],
    "total_count": 138,
    "hidden_count": 0
  }
}

Izmena, premeštanje i slaganje#

curl -X PATCH "https://api.morffeus.com/api/v2/cdn/file" \
  -H "Authorization: Bearer $MORFFEUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 7731,
    "alt": "Dog food, 2 kg bag",
    "tags": ["dog", "food"]
  }'

{
  "errors": {
    "CdnFiles": ["API.CdnFiles.FileNotFound"]
  }
}

Zamena fajla#

curl -X POST "https://api.morffeus.com/api/v2/cdn/files/7731/replace" \
  -H "Authorization: Bearer $MORFFEUS_TOKEN" \
  -F "file=@dog-food_new.jpg" \
  -F "cache_strategy=version"

{
  "data": {
    "id": 7731,
    "key": "12-34/products/dog-food.jpg",
    "version": 2,
    …
  },
  "cache": {
    "strategy": "version",
    "url": "https://cdn.example.com/12-34/products/dog-food.jpg?v=2"
  }
}

Gde se fajl koristi#

{
  "data": [
    {
      "entity_type": "product",
      "entity_id": 48377,
      "field": "images",
      "label": "Dog food",
      "url": "https://cdn.example.com/12-34/products/dog-food.jpg",
      "total_count": 2
    },
    {
      "entity_type": "product_variant",
      "entity_id": 91120,
      "field": "image_url",
      …
    }
  ]
}

Brisanje, vraćanje i trajno brisanje#

curl -X DELETE -G "https://api.morffeus.com/api/v2/cdn" \
  -H "Authorization: Bearer $MORFFEUS_TOKEN" \
  --data-urlencode "file=12-34/products/dog_food_old.jpg"

{
  "data": { "message": "File deleted", "success": true }
}

{
  "errors": {
    "CdnFiles": ["API.CdnFiles.FileNotInTrash"]
  }
}

Slike na proizvodima i lokacijama#

Proizvodi, varijante i prodajne lokacije čuvaju URL-ove slika. Da biste koristili fajl iz biblioteke, pošaljite njegov url kao image_url u images proizvoda ili varijante preko POST /int/products. URL čuvamo onako kako ga pošaljete i ne preuzimamo ga, pa radi i URL van biblioteke, ali se ne prati. URL iz biblioteke se odmah računa kao upotreba fajla.

Ovde pomažu još dva čitanja. GET /cdn_upload_presets daje pravila otpremanja vaše aplikacije, sa izlaznim formatom, najvećom širinom, kvalitetom i širinama manjih kopija koje svako primenjuje; podrazumevano ima is_default: true. GET /cdn/files/pdf-renders?name= nalazi PDF-ove čije su stranice pretvorene u slike, sa URL-om svake stranice.

Povezano#

• Proizvodi: gde se postavljaju slike proizvoda i varijanti.
• Lokacije: prodajne lokacije i njihove slike.
• Greške: omotač greške.