Dokumentacja API

Kompletna dokumentacja do tworzenia aplikacji i stron przez HTTP.

Autoryzacja

Wszystkie requesty wymagają api_token (parametr GET lub header Authorization: Bearer TOKEN)

Apps

Interaktywne aplikacje webowe (Svelte 5, Vue 3, React 19, JS, HTML).

Endpointy

Metoda	Ścieżka	Opis
GET	/noe/apps.json	Lista aplikacji
POST	/noe/apps.json	Utworzenie aplikacji
PATCH	/noe/apps/:id.json	Aktualizacja
GET	/noe/:url_code	Uruchomienie aplikacji

Silniki aplikacji

svelte
Svelte 5 z $state/$derived

vue
Vue 3 Composition API

react
React 19 z JSX

js
Czysty JavaScript

html
Czysty HTML

kaboom/phaser
Gry 2D

Przykład - utworzenie aplikacji

POST /noe/apps.json?api_token=TOKEN
Content-Type: application/json

{
  "app": {
    "name": "Moja aplikacja",
    "url_code": "moja-app",
    "app_engine": "svelte",
    "css_engine": "tailwind_all",
    "public": true,
    "source_code": "<script>let count = $state(0);</script>\n<button onclick={() => count++}>{count}</button>"
  }
}

Transforms

Konwersje danych między formatami: JSON, XML, CSV, TXT.

Rodzaje transformacji

json_to_xml / xml_to_json

csv_to_json / txt_to_json

hash_transform - mapping JSON z interpolacją

xsl_transform - transformacja XSLT

Przykład hash_transform

{
  "transform": {
    "name": "Format API Response",
    "code": "format-api",
    "kind": "hash_transform",
    "transform_code": "{\"name\": \"{name.common}\", \"capital\": \"{capital[0]}\"}"
  }
}

Connectors

Połączenia z zewnętrznymi API. Definiuj własne metody HTTP, autoryzację i mapowanie danych.

Przykład Custom Connector

POST /connect/connectors.json?api_token=TOKEN

{
  "connector": {
    "name": "Moje API",
    "code": "my-api",
    "kind": "noe/custom_connector",
    "url": "https://api.example.com",
    "secret_token": "API_KEY",
    "fields": {
      "methods": [
        {
          "method": "get_users",
          "http_method": "GET",
          "path": "/users",
          "object_out": "json_array"
        }
      ]
    }
  }
}

Flow

Przepływy danych łączące transformacje i konektory. Warunkowe wykonanie, pętle, mutacje.

Instrukcje programu

connector - wywołanie konektora

transform - transformacja danych

mutation - modyfikacja danych

each - iteracja po tablicy

if - warunek

case - wielokrotny warunek

CMS

System zarządzania treścią: strony, layouty, paragrafy.

Endpointy

Zasób	Ścieżka
Sites	/cms/sites.json
Layouts	/cms/layouts.json
Pages	/cms/pages.json
Paragraphs	/cms/paragraphs.json
Assets	/cms/assets.json

Liquid Templates

Strony używają szablonów Liquid. Dostępne zmienne:

      Dokumentacja APIKompletna dokumentacja do tworzenia aplikacji i stron przez HTTP.
https://github.com/noeai/api

    Apps
    Transforms
    Connectors
    Flow
    CMS
  
AutoryzacjaWszystkie requesty wymagają api_token (parametr GET lub header Authorization: Bearer TOKEN)
AppsInteraktywne aplikacje webowe (Svelte 5, Vue 3, React 19, JS, HTML).
Endpointy
      
        MetodaŚcieżkaOpis
GET/noe/apps.jsonLista aplikacji
POST/noe/apps.jsonUtworzenie aplikacji
PATCH/noe/apps/:id.jsonAktualizacja
GET/noe/:url_codeUruchomienie aplikacji

    
Silniki aplikacjisvelte
Svelte 5 z $state/$derived
vue
Vue 3 Composition API
react
React 19 z JSX
js
Czysty JavaScript
html
Czysty HTML
kaboom/phaser
Gry 2D
Przykład - utworzenie aplikacjiPOST /noe/apps.json?api_token=TOKEN
Content-Type: application/json

{
  "app": {
    "name": "Moja aplikacja",
    "url_code": "moja-app",
    "app_engine": "svelte",
    "css_engine": "tailwind_all",
    "public": true,
    "source_code": "<script>let count = $state(0);</script>\n<button onclick={() => count++}>{count}</button>"
  }
}TransformsKonwersje danych między formatami: JSON, XML, CSV, TXT.
Rodzaje transformacjijson_to_xml / xml_to_json
csv_to_json / txt_to_json
hash_transform - mapping JSON z interpolacją
xsl_transform - transformacja XSLT
Przykład hash_transform{
  "transform": {
    "name": "Format API Response",
    "code": "format-api",
    "kind": "hash_transform",
    "transform_code": "{\"name\": \"{name.common}\", \"capital\": \"{capital[0]}\"}"
  }
}ConnectorsPołączenia z zewnętrznymi API. Definiuj własne metody HTTP, autoryzację i mapowanie danych.
Przykład Custom ConnectorPOST /connect/connectors.json?api_token=TOKEN

{
  "connector": {
    "name": "Moje API",
    "code": "my-api",
    "kind": "noe/custom_connector",
    "url": "https://api.example.com",
    "secret_token": "API_KEY",
    "fields": {
      "methods": [
        {
          "method": "get_users",
          "http_method": "GET",
          "path": "/users",
          "object_out": "json_array"
        }
      ]
    }
  }
}FlowPrzepływy danych łączące transformacje i konektory. Warunkowe wykonanie, pętle, mutacje.
Instrukcje programuconnector - wywołanie konektora
transform - transformacja danych
mutation - modyfikacja danych
each - iteracja po tablicy
if - warunek
case - wielokrotny warunek
CMSSystem zarządzania treścią: strony, layouty, paragrafy.
Endpointy
      
        ZasóbŚcieżka
Sites/cms/sites.json
Layouts/cms/layouts.json
Pages/cms/pages.json
Paragraphs/cms/paragraphs.json
Assets/cms/assets.json

    
Liquid TemplatesStrony używają szablonów Liquid. Dostępne zmienne:

      {{ content }} - treść strony

      {{ page.name }} - nazwa strony

      {{ site.name }} - nazwa site

      {{ pages }} - lista stron (do menu)

      <cms type="box" id="features"> - wstawienie paragrafów z boxa
    
Klonowanie SitePOST /cms/sites.json?api_token=TOKEN

{
  "from_site_code": "produkcja",
  "deep_clone": "1",
  "site": {
    "name": "Wersja testowa",
    "code": "produkcja-test"
  }
}Pełna dokumentacja dostępna w panelu administracyjnym NOE
 - treść strony

      API - nazwa strony

      NOE5 - nazwa site

       - lista stron (do menu)

      <cms type="box" id="features"> - wstawienie paragrafów z boxa
    

Klonowanie Site

POST /cms/sites.json?api_token=TOKEN

{
  "from_site_code": "produkcja",
  "deep_clone": "1",
  "site": {
    "name": "Wersja testowa",
    "code": "produkcja-test"
  }
}

Pełna dokumentacja dostępna w panelu administracyjnym NOE