API-dokumentaatio

Luo QR-koodeja ja viivakoodeja tuotteestasi REST-APIlla. Lähetä JSON osoitteeseen /api/v1, saat isännöidyn SVG-grafiikan ja listaa tai päivitä samat resurssit.

Luo QR-koodi

POST /api/v1/qr-codes tyypillä, sisällöllä ja valinnaisella suunnittelulla: värit, modulityyli, logo, silmät ja kehys. Vastaus sisältää isännöidyn SVG-URL:n.

{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}
QR-luonnin viite

Luo viivakoodi

POST /api/v1/barcodes symbologialla, value-arvolla ja valinnaisilla väreillä tai koolla. Käytössä on 34 tyyppiä, Code 128:sta EAN-13:een.

{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}
Viivakoodin luonnin viite

Todennus

Lähetä API-avain Bearer-tokenina jokaisessa pyynnössä. Löydät tai uudistat avaimen kohdasta Hallintapaneeli → Tili → API.

Authorization: Bearer YOUR_API_KEY

Perus-URL: https://forqrcode.com/api/v1

Nopeusrajoitukset

Jokainen API-avain on rajoitettu 60 pyyntöön minuutissa. Vastaukset sisältävät X-RateLimit-Limit-, X-RateLimit-Remaining- ja X-RateLimit-Reset-otsikot.

Virheet

Virheet noudattavat JSON:API-muotoa:

{ "errors": [{ "title": "…", "status": "422" }] }

Validointivirheet voivat sisältää source.pointer-kentän.