Kuva URL-osoitteeksi logo

API-dokumentaatio

API-käyttö edellyttää aktiivista Pro- tai Premium-tilausta. Todenna API-avaimella ja lataa kuvat samaan kirjastoon, jonka näet Dashboardissa. Kiintiöt vastaavat sivuston maksullista tilaustasi.

Tuotekuvat

Lataa kuva

POST /api/v1/upload multipart/form-data-muodossa.

Parametrit

Authorization
Pakollinen. Pyynnön otsikko. Muoto: Bearer API_AVAIMESI.
file
Pakollinen. Binääritiedosto tai base64-data.
name
Valinnainen. Tiedostonimi; tunnistuu automaattisesti paikallisessa multipart-lähetyksessä.

Esimerkkipyyntö

Binääritiedosto

curl https://phototourl.com/api/v1/upload \
  -X POST \
  -H "Authorization: Bearer ptu_live_YOUR_KEY" \
  -F "file=@./product.jpg"

Base64

curl https://phototourl.com/api/v1/upload \
  -X POST \
  -H "Authorization: Bearer ptu_live_YOUR_KEY" \
  -F "file=R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" \
  -F "name=pixel.gif"

Käytä aina POST-metodia paikallisen tiedoston lähetykseen. GET ei ole tuettu.

Vastauskentät

id
Resurssin id kirjastossasi.
url
CDN-osoite tuotesivuilla käytettäväksi.
fileName
Alkuperäinen tiedostonimi.
fileSize
Tiedoston koko tavuina.
mimeType
Ladatun tiedoston MIME-tyyppi.
createdAt
Latausaika UTC:ssä, muodossa YYYY-MM-DD HH:mm:ss.
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://cdn.phototourl.com/pro/2026-11-05-a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg",
  "fileName": "product.jpg",
  "fileSize": 128472,
  "mimeType": "image/jpeg",
  "createdAt": "2026-11-05 10:20:30"
}

Listaa kuvat

GET /api/v1/images valinnaisilla page- ja pageSize-parametreilla (enintään 100).

curl "https://phototourl.com/api/v1/images?page=1&pageSize=20" \
  -H "Authorization: Bearer ptu_live_YOUR_KEY"

Vastauskentät

resources
Kuvataulukko: id, fileName, url, fileSize, mimeType, createdAt.
page
Nykyinen sivunumero.
pageSize
Kohteita sivulla.
total
Kuvien kokonaismäärä kirjastossa.
{
  "resources": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fileName": "product.jpg",
      "url": "https://cdn.phototourl.com/pro/2026-11-05-a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg",
      "fileSize": 128472,
      "mimeType": "image/jpeg",
      "createdAt": "2026-11-05 10:20:30"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 1
}

Poista kuva

DELETE /api/v1/images/:id. Poistaa tiedoston tallennuksesta ja kirjastostasi.

curl -X DELETE https://phototourl.com/api/v1/images/RESOURCE_ID \
  -H "Authorization: Bearer ptu_live_YOUR_KEY"

Vastauskentät

success
true, kun kuva poistettiin.
{ "success": true }

Rajat

API ei ole käytettävissä Free-tilauksella. Pro ja Premium käyttävät tilauksesi lataus-, tallennus- ja tiedostokokorajoja. Kun ylität rajan, API palauttaa virheen upgradeUrl-kentällä.

Virheet

Epäonnistuneet pyynnöt palauttavat virhekoodin. Kiintiövirheet voivat sisältää upgradeUrl-kentän.

  • dailyLimitReached— Päivittäinen latausraja saavutettu (HTTP 429).
  • storageLimitReached— Tallennuskiintiö ylitetty (HTTP 413).
  • fileTooLarge— Tiedosto suurempi kuin tilaus sallii (HTTP 400).
  • 401— Puuttuva, virheellinen tai peruutettu API-avain.
{
  "error": "dailyLimitReached",
  "errorParams": { "limit": 1000 },
  "plan": "paid",
  "limit": 1000,
  "upgradeUrl": "https://www.phototourl.com/pricing"
}