API REST di Wiresphere

Parametri header

Request Body (application/json)

{
  "username": "il-suo-username",
  "password": "la-sua-password"
}

Risposta

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Header

Parametri query

Risposta (200)

{
  "totalElements": 42,
  "totalPages": 5,
  "size": 10,
  "number": 0,
  "first": true,
  "last": false,
  "content": [
    {
      "base": { /* Dati base del prodotto */ },
      "additional": { /* Dati aggiuntivi */ }
    }
  ]
}

Parametri path

Risposta (200) — ProductDataDTO

{
  "base": { /* Dati base del prodotto (nome, SKU, prezzo ecc.) */ },
  "additional": { /* Campi estesi */ }
}

Request Body (application/json) — ProductDataDTO

{
  "base": {
    // Campi obbligatori e dati del prodotto (nome, SKU, prezzo, stato ecc.)
  },
  "additional": {
    // Campi aggiuntivi opzionali
  }
}

Risposta

Request Body (application/json)

["idProdotto1", "idProdotto2"]

Risposta

Restituisce tutte le operazioni bulk registrate con i relativi schemi dei parametri.

Risposta (200) — Array di ProductOperationRegistrationDTO

[{
  "operationId": "set-status",
  "description": "Imposta lo stato dei prodotti",
  "parameterTypes": { "status": "string" },
  "previewProperties": ["status"]
}]

Simula un'operazione bulk e mostra lo stato prima/dopo — senza salvare i dati.

Request Body

{
  "operationId": "set-status",
  "parameters": { "status": "ACTIVE" },
  "confirmAll": false
}

Esegue un'operazione bulk sui prodotti filtrati. Modifica i dati in modo permanente.

Parametri query

Request Body

{
  "operationId": "set-status",
  "parameters": { "status": "INACTIVE" }
}

Campi filtro (parametro f)

Campi di ordinamento (parametro o)

createdAt, docId, payload.netTotalPrice, payload.grossTotalPrice, payload.customer.name

Esempio

GET /api/v1/admin/transaction/?f=doctype::ORDER,min_createdAt::2024-01-01T00:00:00.000Z&o=createdAt::DESC&p=0&s=20
Authorization: Bearer <token>
tenant-id: mio-shop

Parametri path

Parametri query

Risposta (200)

{
  "doctype": ["ORDER", "INVOICE"],
  "payload.channel": ["online", "terminal"]
}

Parametri path

Parametri query

Parametri path

Parametri query

Opzioni di filtro e ordinamento identiche all'endpoint admin, ma senza autenticazione Bearer. Filtra sui dati accessibili nel contesto dello shop.

Campi filtro (parametro f)

personId, firstName, lastName, email

Risposta (200) — PageCrmPersonDTO

{
  "totalElements": 100,
  "content": [{
    "id": "507f1f77bcf86cd799439011",
    "firstName": "Mario",
    "lastName": "Rossi",
    "email": "mario@example.com",
    "personId": "esterno-123",
    "addresses": [],
    "communications": [],
    "organisations": [],
    "types": []
  }]
}

Parametri path

Request Body (application/json) — PersonDTO

{
  "firstName": "Mario",
  "lastName": "Rossi",
  "email": "mario@example.com",
  "salutation": "Sig.",
  "title": "Dott.",
  "personId": "id-esterno-123",
  "addresses": [{
    "street": "Via Esempio",
    "streetNumber": "1",
    "zipCode": "12345",
    "city": "Città Esempio",
    "country": "IT",
    "type": "MAIN"
  }],
  "communications": [{
    "type": "PHONE",
    "value": "+39 012 3456789"
  }],
  "types": []
}

Stesso request body del POST. Sostituzione completa del record.

Request Body — RelationDeltaDTO

{
  "add": ["orgId1", "orgId2"],
  "remove": ["orgIdVecchio"]
}

Risposta (200) — OkDTO

{ "ok": true }

Request Body

["id1", "id2", "id3"]

Campi filtro

name (ricerca per substring)

Risposta (200) — PageCrmOrganisationDTO

{
  "totalElements": 10,
  "content": [{
    "id": "...",
    "name": "Esempio S.r.l.",
    "organisationId": "id-esterno",
    "addresses": [],
    "communications": [],
    "people": [],
    "types": []
  }]
}

Request Body — OrganisationDTO

{
  "name": "Esempio S.r.l.",
  "organisationId": "id-esterno",
  "addresses": [],
  "communications": [],
  "types": []
}

Request Body — RelationDeltaDTO

{
  "add": ["personId1"],
  "remove": []
}

Risposta — PageSlug

{
  "content": [{
    "id": "507f...",
    "slug": "beton-c25-30",
    "label": "Calcestruzzo C25/30",
    "objectType": "product",
    "collection": "products",
    "refId": "idMongoProdotto",
    "inactive": false
  }]
}

Request Body — Slug

{
  "id": "507f...",           // Da indicare in caso di update
  "slug": "mio-slug",       // Segmento URL (obbligatorio)
  "collection": "products",  // Collection MongoDB (obbligatorio)
  "objectType": "product",   // "product" oppure "product-list" (obbligatorio)
  "refId": "...",            // ID prodotto (con objectType "product")
  "fields": {                  // Filtri per "product-list"
    "category": "beton"
  },
  "defaultSort": [{ "field": "name", "direction": "asc" }],
  "context": ["main-nav"],
  "inactive": false
}

Utile per trovare lo slug di un prodotto noto.

Parametri path

Parametri query

Parametri query

Risposta (200)

["main-nav", "footer", "sidebar"]

Request Body — Array di ItemOrderDTO

[
  { "sku": "SKU-001", "categoryId": "catId", "order": 0 },
  { "sku": "SKU-002", "categoryId": "catId", "order": 1 }
]

Request Body — NavigationUpdateDTO

{
  "slugId": "slugMongoId",
  "navigationNames": ["main-nav", "footer"]
}

Parametri path

Request Body — Setting

{
  "key": "chiave-impostazione",
  "public": {
    // Impostazioni accessibili pubblicamente
    "theme": "dark"
  },
  "private": {
    // Accessibile solo alle richieste autenticate
    "apiKey": "secret"
  }
}

Parametri query

Request come multipart/form-data con il campo file.

Content-Type: multipart/form-data

file: [binary data]

Risposta (200)

{ "publishableKey": "pk_live_..." }

Restituisce lo stato attuale dei pagamenti dello shop.

Header

Risposta (200) — WebhookTestStatusDTO

{
  "sandbox": {
    "mode": "SANDBOX",
    "passed": true,
    "ranAt": "2024-01-15T10:30:00Z",
    "durationMs": 234,
    "pending": false
  },
  "production": { /* analogo */ }
}

Parametri path

Request Body (multipart)

Content-Type: application/json
file: [binary — file CSV o JSON]

Risposta (200) — UploadResponse

{
  "success": true,
  "importCount": 42
}

Parametri path

Risposta

File binario (string format: binary)