Documentazione API

Quoparts mette a disposizione un servizio REST API, per integrazioni da sistemi esterni.
Questa documentazione fornisce informazioni sugli endpoint disponibili e su come interagire con essi.

API Endpoint Base

{BASE_URL}/ws_quoparts.php

1. Autenticazione

L'API Login consente di autenticarsi al sistema QuoParts e ottenere un token necessario per le chiamate successive.

GET {BASE_URL}/ws_quoparts.php?login=&username={USER}&password={PWD}

Parametri URL

Parametro	Tipo	Obbligatorio	Descrizione
`login`	string	SÌ	Nome metodo.
`username`	string	SÌ	Username per l'autenticazione.
`password`	string	SÌ	Password per l'autenticazione.

Esempio cURL



curl -X GET "{BASE_URL}/ws_quoparts.php?login=&username=CODICE_UTENTE&password=PASSWORD_UTENTE"

Risposta

Struttura della risposta

La risposta contiene un oggetto JSON con le informazioni di autenticazione.

{
  "errorCode": "string",
  "error": "string",
  "data": [
    {
      "TOKEN": "string"
    }
  ]
}

Campi Output

Campo	Descrizione	Tipo	Note
`errorCode`	Codice errore (`0` se successo, altro valore se errore)	string	Sempre presente
`error`	Descrizione errore (vuoto se successo)	string	Sempre presente
`data`	Array contenente il token di autenticazione	array	Sempre presente
`data[].TOKEN`	Token di autenticazione	string	Solo se successo

Esempio Risposta (Successo)

{
  "errorCode": "0",
  "error": "",
  "data": [
    {
      "TOKEN": "40919716769452007349723.39576135"
    }
  ]
}

Esempio Risposta (Errore)

{
  "errorCode": "101",
  "error": "Utente non Accreditato",
  "data": []
}

Note Tecniche

Il token restituito deve essere utilizzato per tutte le richieste successive.
In caso di token scaduto, è necessario effettuare nuovamente il login.

2. Import Clienti

L'API consente di trasmettere anagrafiche cliente al sistema QuoParts e generare le relative credenziali.

POST {BASE_URL}/ws_quoparts.php?importCli=&token={TOKEN}

Parametri URL

Parametro	Tipo	Obbligatorio	Descrizione
`importCli`	string	SÌ	Nome metodo.
`token`	string	SÌ	Token di autenticazione ottenuto tramite API Login.

Struttura Payload (JSON)

Inviare un oggetto JSON con proprietà data contenente un array di clienti.

Struttura del payload

{
  "data": [
    {
      "DES_NOM": "string",
      "DES_IND": "string",
      "DES_CTA": "string",
      "COD_PRN": "string",
      "COD_CAP": "string",
      "COD_EML": "string",
      "COD_PTA_IVA": "string",
      "FLG_ATV": "string",
      "COD_CLI_ERP": "string"
    }
  ]
}

Campi Input

Campo	Tipo	Obbligatorio	Descrizione
`DES_NOM`	string	SÌ	Ragione Sociale.
`DES_IND`	string	No	Indirizzo.
`DES_CTA`	string	No	Città.
`COD_PRN`	string	No	Provincia (es: MI).
`COD_CAP`	string	No	CAP.
`COD_EML`	string	No	Email.
`COD_PTA_IVA`	string	SÌ	Partita IVA.
`FLG_ATV`	string	No	Stato (0=non attivo; 1=attivo). Default: 1.
`COD_CLI_ERP`	string	SÌ	Codice Cliente Gestionale univoco.

Esempio cURL

curl -X POST "{BASE_URL}/ws_quoparts.php?importCli=&token=TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": [
      {
        "DES_NOM": "Rossi S.r.l.",
        "DES_IND": "Via Roma 123",
        "DES_CTA": "Milano",
        "COD_PRN": "MI",
        "COD_CAP": "20121",
        "COD_EML": "info@rossisrl.it",
        "COD_PTA_IVA": "12345678901",
        "FLG_ATV": "1",
        "COD_CLI_ERP": "CLI001"
      }
    ]
  }'

Risposta

Struttura della risposta

La risposta contiene un array di oggetti con le informazioni per ciascun cliente processato, correlate al COD_CLI_ERP trasmesso.

{
  "errorCode": "string",
  "error": "string",
  "data": [
    {
      "errorCode": "string",
      "error": "string",
      "COD_CLI_ERP": "string",
      "COD_CLI": "string",
      "COD_USR": "string",
      "COD_PWD": "string"
    }
  ]
}

Campi Output

Campo	Descrizione	Tipo	Note
`errorCode`	Codice errore	string	Sempre presente. `0` se successo
`error`	Descrizione errore	string	Sempre presente. Vuoto se successo
`data`	Array contenente i dati del cliente e relative credenziali	array	Sempre presente. Vuoto se errore
`data[].errorCode`	Codice errore creazione cliente	string	Sempre presente. `0` se successo
`data[].error`	Descrizione errore creazione cliente	string	Sempre presente. Vuoto se successo
`data[].COD_CLI_ERP`	Codice Cliente Gestionale (ricevuto in input)	string	Sempre presente
`data[].COD_CLI`	Codice Cliente QuoParts generato/associato	string	Solo se successo
`data[].COD_USR`	Username QuoParts generato	string	Solo se successo
`data[].COD_PWD`	Password QuoParts generata	string	Solo se successo

Esempio Risposta (Successo)

{
  "errorCode": "0",
  "error": "",
  "data": [
    {
      "errorCode": "0",
      "error": "",
      "COD_CLI_ERP": "CLI001",
      "COD_CLI": "000015",
      "COD_USR": "M00015",
      "COD_PWD": "O8HMER"
    }
  ]
}

Esempio Risposta (Errore)

{
  "errorCode": "100",
  "error": "Richiesta errata",
  "data": []
}

Note Tecniche

Il campo FLG_ATV, se omesso, viene automaticamente impostato a 1 (attivo).

3. Import Preventivi

Consente di trasmettere richieste di preventivo al portale QuoParts.

POST {BASE_URL}/ws_quoparts.php?importPvt=&token={TOKEN}

Parametri URL

Parametro	Tipo	Obbligatorio	Descrizione
`importPvt`	string	SÌ	Nome metodo.
`token`	string	SÌ	Token di autenticazione ottenuto tramite API Login.

Struttura Payload (JSON)

Il body deve contenere un oggetto data diviso in testata e articoli.

Struttura del payload

{
  "data": {
    "testata": {
      "COD_CLI": "string",
      "COD_CLI_ERP": "string",
      "COD_TGA": "string",
      "COD_TLO": "string",
      "DES_VCL": "string",
      "DES_NOM_SPD": "string",
      "DES_IND_SPD": "string",
      "DES_CTA_SPD": "string",
      "COD_PRN_SPD": "string",
      "COD_CAP_SPD": "string"
    },
    "articoli": [
      {
        "DES_RGR": "string",
        "COD_ART_PVT": "string",
        "DES_ART_PVT": "string",
        "IMP_LST_PVT": number,
        "QTA_DET_PVT": number
      }
    ]
  }
}

Campi Input Testata

I seguenti campi rappresentano l'intestazione del preventivo e sono presenti una sola volta per richiesta.

Campo	Tipo	Obbligatorio	Descrizione
`COD_CLI`	string	SÌ*	Codice Cliente QuoParts. *Alternativo a COD_CLI_ERP
`COD_CLI_ERP`	string	SÌ*	Codice Cliente Gestionale. *Alternativo a COD_CLI
`COD_TGA`	string	SÌ	Targa veicolo.
`DES_VCL`	string	SÌ	Descrizione Veicolo.
`COD_TLO`	string	No	Telaio.
`DES_NOM_SPD`	string	No	Cliente di spedizione.
`DES_IND_SPD`	string	No	Indirizzo di spedizione.
`DES_CTA_SPD`	string	No	Città di spedizione.
`COD_PRN_SPD`	string	No	Provincia di spedizione. (es: MI, RM)
`COD_CAP_SPD`	string	No	CAP di spedizione.

Campi Articoli (Array)

L'array articoli contiene la lista degli articoli da preventivare.

Campo	Tipo	Obbligatorio	Descrizione
`DES_RGR`	string	SÌ	Descrizione generica dell'articolo.
`COD_ART_PVT`	string	SÌ	Codice OE articolo.
`DES_ART_PVT`	string	No	Descrizione specifica dell'articolo.
`IMP_LST_PVT`	number	No	Importo Listino OE.
`QTA_DET_PVT`	number	No	Quantità.

Esempio cURL

curl -X POST "{BASE_URL}/ws_quoparts.php?importPvt=&token=YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "testata": {
        "COD_CLI": "000015",
        "COD_CLI_ERP": "CLI001",
        "COD_TGA": "TE001ST",
        "DES_VCL": "FORD B-Max 1.6 Ti-VCT Benzina"
      },
      "articoli": [
        {
          "DES_RGR": "Filtro olio",
          "COD_ART_PVT": "1883037",
          "DES_ART_PVT": "Filtro olio motore",
          "IMP_LST_PVT": 14.57,
          "QTA_DET_PVT": 1
        }
      ]
    }
  }'

Risposta

Struttura della risposta

La risposta contiene un oggetto JSON con l'esito dell'operazione.

{
  "errorCode": "string",
  "error": "string",
  "data": [
    {
      "COD_DOC": "string"
    }  
  ]
}

Campi Output

Campo	Descrizione	Tipo	Obbligatorio
`errorCode`	Codice errore (`0` se successo, altro valore se errore)	string	Sempre presente
`error`	Descrizione errore (vuoto se successo)	string	Sempre presente
`data`	Array contenente i dati del preventivo creato	array	Sempre presente. Vuoto se errore
`data[].COD_DOC`	Codice Documento/Preventivo QuoParts generato	string	Solo se successo

Esempio Risposta (Successo)

{
  "errorCode": "0",
  "error": "",
  "data": [
    {
      "COD_DOC": "000001"
    }
  ]
}

Esempio Risposta (Errore)

{
  "errorCode": "107",
  "error": "Errore durante la creazione del preventivo",
  "data": []
}

Note Tecniche

È necessario valorizzare almeno uno tra COD_CLI e COD_CLI_ERP per identificare il cliente.
Se COD_CLI e COD_CLI_ERP sono entrambi valorizzati, il sistema utilizza prioritariamente COD_CLI.
L'array articoli deve contenere almeno un elemento.
I campi numerici (IMP_LST_PVT, QTA_DET_PVT) devono essere in formato numerico.