API ஆவணம்

Nordic Layers என்பது https://app.layers.nordicbyte.co.uk இல் HTTPS வழியாக இயங்கும் REST API. திட்டம் என்பது லேயர்களின் JSON ஆவணம்; செயல்பாடுகள் மூலம் அதை மாற்றி, படமாக ஏற்றுமதி செய்கிறீர்கள். உலாவி எடிட்டரும் இதே API-யைப் பயன்படுத்துகிறது.

அங்கீகாரம்

உங்கள் கணக்குப் பலகையில் API விசையை உருவாக்கி, ஒவ்வொரு /v1 கோரிக்கையிலும் அனுப்புங்கள். விசைகள் nl_key_ என்று தொடங்கும்.

Authorization: Bearer nl_key_…

வழக்கமான செயல்முறை

பதிவேற்றம் ஒவ்வொரு படத்தையும் POST /v1/assets மூலம், கோப்பையே கோரிக்கை உடலாக அனுப்பி (PNG, JPEG, WebP, GIF, BMP அல்லது TIFF). பதிலில் அதன் id இருக்கும்.
உருவாக்கம் ஒரு திட்டத்தை POST /v1/projects மூலம், width, height, background உடன். முதல் steps ஐ அதே அழைப்பில் அனுப்பலாம்.
திருத்தம் POST /v1/projects/{id}/run மூலம்: ஒரு செயல்பாட்டை {"op": …} ஆகவோ பலவற்றை {"steps": [...]} ஆகவோ. GET /v1/projects/{id}/preview மூலம் பாருங்கள், இது இலவசம்.
ஏற்றுமதி POST /v1/projects/{id}/export மூலம். பதிலில் கோப்பின் URL இருக்கும்; "response": "image" கொடுத்தால் படமே வரும்.

முதல் கோரிக்கை

கிரேடியன்ட்டும் தலைப்பும் கொண்ட 1080×1080 திட்டத்தை உருவாக்கி, WebP ஆக ஏற்றுமதி செய்யுங்கள்:

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "First post",
    "width": 1080,
    "height": 1080,
    "steps": [
      {"op": "layer.addFill", "gradient": {"colors": ["#1E3A5F", "#64B5F6"], "angle": 135}},
      {"op": "text.add", "content": "Hello, layers", "fontName": "Segoe UI", "fontSize": 110, "bold": true, "color": "#FFFFFF"},
      {"op": "effects.set", "shadow": {"opacity": 0.4, "distance": 12, "size": 24}}
    ]
  }'

# → {"project": {"id": "…", …}}

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$PROJECT_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "webp",
    "quality": 90
  }'

எண்ட்பாயின்ட்கள்

மெத்தட்	பாத்	என்ன செய்கிறது
`GET`	`/health`	சேவை நிலை
`GET`	`/v1/ops`	ஒவ்வொரு செயல்பாட்டினதும் அதன் அளவுருக்களினதும் பட்டியல் (பொது)
`POST`	`/v1/assets?name=photo.jpg`	படத்தைப் பதிவேற்றுங்கள்; உடலே கோப்பு
`GET`	`/v1/assets`	உங்கள் படங்களின் பட்டியல், எந்தத் திட்டம் அவற்றைப் பயன்படுத்துகிறது என்பதுடன்
`DELETE`	`/v1/assets/{id}`	படத்தை நீக்குங்கள்
`POST`	`/v1/projects`	திட்டத்தை உருவாக்குங்கள் (கேன்வாஸ், அல்லது முழு ஆவணம், விருப்பப் படிகளுடன்)
`GET`	`/v1/projects`	உங்கள் திட்டங்களின் பட்டியல்
`GET`	`/v1/projects/{id}`	ஒரு திட்டம் அதன் ஆவணத்துடன்
`PUT`	`/v1/projects/{id}/document`	முழு ஆவணத்தையும் மாற்றுங்கள்
`POST`	`/v1/projects/{id}/run`	ஒரு செயல்பாட்டை அல்லது படிகளின் பட்டியலைப் பயன்படுத்துங்கள்
`POST`	`/v1/projects/{id}/undo`	கடைசி மாற்றத்தைச் செயல்தவிர்
`POST`	`/v1/projects/{id}/redo`	மீண்டும் செய்
`GET`	`/v1/projects/{id}/preview?size=1024`	இலவச PNG முன்னோட்டம், நீண்ட பக்கம் `size` px வரை
`POST`	`/v1/projects/{id}/export`	PNG, JPEG அல்லது WebP ஏற்றுமதி; இந்தக் கோப்புக்கு மட்டும் விருப்பப் படிகள்
`POST`	`/v1/render`	முழு ஆவணத்தின் நிலையற்ற ரெண்டர்
`GET`	`/v1/exports`	உங்கள் ஏற்றுமதிகளின் பட்டியல்
`GET`	`/v1/exports/{id}/file`	ஏற்றுமதியைப் பதிவிறக்குங்கள்
`DELETE`	`/v1/projects/{id}`	திட்டத்தை நீக்குங்கள்

செயல்பாடுகள்

ஒவ்வொரு செயல்பாடும் op மற்றும் அதன் அளவுருக்கள் கொண்ட ஆப்ஜெக்ட். லேயர்கள் id அல்லது பெயரால் குறிப்பிடப்படும்; layer இல்லையெனில் செயலில் உள்ள லேயர் பயன்படுத்தப்படும். பெயர்களில் எழுத்து வடிவமும் இடைவெளிகளும் புறக்கணிக்கப்படும், எனவே "Linear Dodge (Add)" மற்றும் "linearDodge" ஒரே பிளெண்ட் மோடு. steps உடன் அவை வரிசையாக இயங்கி முதல் பிழையில் நிற்கும் ("stopOnError": false இல்லையெனில்); அதற்கு முந்தைய படிகள் பயன்படுத்தப்பட்டே இருக்கும்.

லேயர்கள்
உரை
வடிவங்கள்
உருமாற்றம்
லேயரில் அட்ஜஸ்ட்மென்ட்கள்
ஃபில்டர்கள்
அட்ஜஸ்ட்மென்ட் லேயர்கள்
லேயர் மாஸ்க்குகள்
லேயர் எஃபெக்ட்கள்
கேன்வாஸ்
திட்டம்

லேயர்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`layer.add`	`color, name`	Alias of layer.addFill (the web has no empty pixel layers).
`layer.addFill`	`color \| gradient {colors: [..], angle, type: linear\|radial}, name, above, atBottom`	A colour or gradient layer the size of the canvas.
`layer.addImage`	`asset_id \| color, name, rect \| origin \| center, width, height, fit (stretch\|contain\|cover), fitCanvas (contain\|cover), above, atBottom, opacity, blendMode`	Add an uploaded image (asset_id) or a solid colour (color).
`layer.clip`	`layer`	Clip a layer to the one below it (clipping mask).
`layer.delete`	`layer \| layers`	Delete layers.
`layer.duplicate`	`layer, name`	Copy a layer above itself.
`layer.get`	`layer`	One layer with all its settings.
`layer.list`	—	Layers from bottom to top.
`layer.move`	`layer, above \| below (layer), toTop, atBottom, index, offset`	Reorder a layer.
`layer.rename`	`layer, name`	Rename a layer.
`layer.select`	`layer`	Make a layer the active one.
`layer.setBlendMode`	`layer \| layers, blendMode (normal, darken, multiply, colorBurn, linearBurn, lighten, screen, colorDodge, linearDodge, overlay, softLight, hardLight, difference, exclusion, subtract, divide, hue, saturation, color, luminosity)`	Blend mode.
`layer.setFill`	`layer, color \| gradient`	Change a fill layer's colour or gradient.
`layer.setImage`	`layer, asset_id, fit (stretch\|contain\|cover)`	Replace a layer's image and keep its box (templates).
`layer.setOpacity`	`layer \| layers, opacity`	Layer opacity, 0 to 1.
`layer.setVisible`	`layer \| layers, visible`	Show or hide layers.
`layer.unclip`	`layer`	Release a clipping mask.

உரை

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`text.add`	`content, fontName, fontSize, color, alignment, leading, bold, italic, boxWidth, origin \| center, name`	Add a text layer.
`text.defaults`	—	Fonts on the server and whether complex scripts are shaped.
`text.set`	`layer, content, fontName, fontSize, color, alignment, leading, bold, italic, boxWidth`	Change a text layer.

வடிவங்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`shape.add`	`shape, rect \| from+to, color, cornerRadius, lineWidth, name`	Add a rectangle, ellipse or line.
`shape.set`	`layer, color, cornerRadius, lineWidth`	Change a shape layer.

உருமாற்றம்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`transform.flip`	`layer \| layers, axis (horizontal\|vertical)`	Flip horizontally or vertically.
`transform.move`	`layer \| layers, dx, dy \| to [x, y]`	Move by dx/dy or to a point.
`transform.rotate`	`layer \| layers, angle`	Rotate by an angle (degrees, clockwise).
`transform.scale`	`layer \| layers, factor \| percent \| width \| height`	Scale around each layer's centre.
`transform.set`	`layer \| layers, x, y, width, height, rotation, flipX, flipY`	Box, rotation and flips.

லேயரில் அட்ஜஸ்ட்மென்ட்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`adjust.blackWhite`	`layer \| layers, reds, yellows, greens, cyans, blues, magentas, tint, tintHue, tintSaturation`	Non-destructive blackWhite on a layer (adds it or updates it).
`adjust.brightnessContrast`	`layer \| layers, brightness, contrast`	Non-destructive brightnessContrast on a layer (adds it or updates it).
`adjust.clear`	`layer \| layers`	Remove every adjustment and filter from a layer.
`adjust.colorBalance`	`layer \| layers, shadows, midtones, highlights, preserveLuminosity`	Non-destructive colorBalance on a layer (adds it or updates it).
`adjust.curves`	`layer \| layers, rgb, red, green, blue`	Non-destructive curves on a layer (adds it or updates it).
`adjust.exposure`	`layer \| layers, exposure, offset, gamma`	Non-destructive exposure on a layer (adds it or updates it).
`adjust.gradientMap`	`layer \| layers, shadows, highlights, reversed`	Non-destructive gradientMap on a layer (adds it or updates it).
`adjust.grain`	`layer \| layers, amount, size, seed`	Non-destructive grain on a layer (adds it or updates it).
`adjust.hueSaturation`	`layer \| layers, hue, saturation, lightness, colorize`	Non-destructive hueSaturation on a layer (adds it or updates it).
`adjust.invert`	`layer \| layers, no settings`	Non-destructive invert on a layer (adds it or updates it).
`adjust.levels`	`layer \| layers, black, white, gamma, outputBlack, outputWhite`	Non-destructive levels on a layer (adds it or updates it).
`adjust.remove`	`layer \| layers, kind`	Remove one adjustment or filter from a layer.

ஃபில்டர்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`filter.addNoise`	`layer \| layers, amount, gaussian, monochromatic, seed`	Non-destructive addNoise on a layer (adds it or updates it).
`filter.gaussianBlur`	`layer \| layers, radius`	Non-destructive gaussianBlur on a layer (adds it or updates it).
`filter.motionBlur`	`layer \| layers, angle, distance`	Non-destructive motionBlur on a layer (adds it or updates it).
`filter.pixelate`	`layer \| layers, size`	Non-destructive pixelate on a layer (adds it or updates it).
`filter.sharpen`	`layer \| layers, amount, radius, threshold`	Non-destructive sharpen on a layer (adds it or updates it).
`filter.vignette`	`layer \| layers, amount, midpoint, roundness, feather, color`	Non-destructive vignette on a layer (adds it or updates it).

அட்ஜஸ்ட்மென்ட் லேயர்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`adjustmentLayer.add`	`kind, settings…, name, above`	An adjustment layer: changes everything below it.
`adjustmentLayer.get`	`layer`	An adjustment layer's settings.
`adjustmentLayer.set`	`layer, settings…`	Change an adjustment layer (partial).

லேயர் மாஸ்க்குகள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`mask.add`	`layer, reveal \| hide \| rect \| ellipse (rect) \| gradient (from, to) \| asset_id (+ rect), feather, invert, cornerRadius`	Add or replace a layer mask.
`mask.blur`	`layer, radius`	Feather the layer mask.
`mask.delete`	`layer`	Remove the layer mask.
`mask.invert`	`layer`	Invert the layer mask.
`mask.setEnabled`	`layer, enabled`	Turn the layer mask on or off.

லேயர் எஃபெக்ட்கள்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`effects.copy`	`from, layer \| layers`	Copy effects from one layer to others.
`effects.get`	`layer`	A layer's effects.
`effects.remove`	`layer \| layers, kinds`	Remove effects (all, or the ones named).
`effects.set`	`layer \| layers, shadow {…}, stroke {…}, outerGlow {…}, colorOverlay {…}`	Set effects (partial): shadow, outerGlow, stroke, colorOverlay.
`effects.setEnabled`	`layer, kind, enabled`	Turn one effect on or off.

கேன்வாஸ்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`canvas.crop`	`rect [x, y, width, height]`	Crop the canvas to a rectangle.
`canvas.imageSize`	`width and/or height, or percent`	Scale the whole document.
`canvas.setBackground`	`color`	Background colour, or null for transparent.
`canvas.size`	`width, height, anchor (topLeft…bottomRight, default center)`	Change the canvas without scaling layers.

திட்டம்

செயல்பாடு	அளவுருக்கள்	என்ன செய்கிறது
`project.state`	—	The whole document.

பிளெண்ட் மோடுகள்

normal
darken
multiply
colorBurn
linearBurn
lighten
screen
colorDodge
linearDodge
overlay
softLight
hardLight
difference
exclusion
subtract
divide
hue
saturation
color
luminosity

எழுத்துரு குடும்பங்கள்

Arial
Segoe UI
Calibri
Verdana
Tahoma
Trebuchet MS
Georgia
Times New Roman
Courier New
Consolas
Impact
Comic Sans MS

டெம்ப்ளேட்கள்

ஏற்றுமதி அழைப்பில் steps கொடுங்கள்; அவை திட்டத்தின் நகலில் அந்தக் கோப்புக்கு மட்டும் பயன்படுத்தப்படும். ஒரு டெம்ப்ளேட், பல கோப்புகள்: text.set மூலம் உரையையும் layer.setImage மூலம் புகைப்படத்தையும் மாற்றுங்கள்; இது லேயரின் பெட்டியை அப்படியே வைத்திருக்கும்.

curl -X POST https://app.layers.nordicbyte.co.uk/v1/projects/$TEMPLATE_ID/export \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "png",
    "steps": [
      {"op": "text.set", "layer": "Title", "content": "Nueva colección"},
      {"op": "layer.setImage", "layer": "Photo", "asset_id": "photo_dunes"}
    ]
  }'

நிலையற்ற ரெண்டர்

POST /v1/render முழு document ஐ (project.document இல் திரும்பி வருவது போல), விருப்ப steps மற்றும் ஏற்றுமதி விருப்பங்களை ஏற்கும்; திட்டத்தைச் சேமிக்காது. "response": "image" உடன் பதில் படக் கோப்பாகவே இருக்கும்.

curl -X POST https://app.layers.nordicbyte.co.uk/v1/render \
  -H "Authorization: Bearer $NL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {"width": 1200, "height": 630, "background": "#1E3A5F", "layers": ["…"]},
    "format": "png",
    "response": "image"
  }' \
  -o card.png

பிழைகள்

பிழைகள் JSON-இல் நிலையான code மற்றும் உங்கள் கணக்கின் மொழியில் detail செய்தியுடன் வரும். தோல்வியடைந்த படி எந்த அளவுரு தவறு என்று சொல்லும். திட்டத்தின் ரெண்டர்கள் தீர்ந்தால் API 402 மற்றும் quota_renders உடன் பதிலளிக்கும்.

வரம்புகள்

பதிவேற்றங்கள் 50 MB வரை, ஒரு பக்கத்துக்கு 12,000 px வரை.
கேன்வாஸ் ஒரு பக்கத்துக்கு 20,000 px வரை, உங்கள் திட்டத்தின் மெகாபிக்சல்களுக்குள்.
ஒரு அழைப்புக்கு 200 படிகள் வரை.
முன்னோட்டங்கள் நீண்ட பக்கத்தில் 2,048 px வரை.
மெகாபிக்சல்கள், லேயர்கள், திட்டங்கள், சேமிப்பிடம், மாதாந்திர ரெண்டர்கள் திட்டத்தைப் பொறுத்தவை: விலையைப் பாருங்கள்.