GET /api/v1/management/clients/ {clientId} – RetailForce

Questo endpoint restituisce informazioni relative a uno specifico clientId. Viene utilizzato per recuperare i dettagli relativi a un determinato cliente, tra cui:

Dati di identificazione univoca del client
Informazioni sulla licenza
Dati aziendali
Dati aziendali
Informazioni relative al registratore di cassa
Parametri vari

Attenzione: è fondamentale verificare che il clientId esista nel sistema locale. In caso contrario, verrà restituito l’errore “Il client non esiste. (Parametro ‘clientId’)”. Potrebbe essere necessaria un’ulteriore analisi per determinare la causa dell’assenza del clientId nel sistema locale. Se il client non è ancora stato attivato, è necessario procedere con l’attivazione prima di proseguire.

Risultato

Una chiamata riuscita all’endpoint restituisce una risposta HTTP 200 e un oggetto JSON contenente le informazioni richieste sul client.

Esempio:

{
  "uniqueClientId": "4ac109f5-5c7b-4173-b3b7-b403f472ac8f",
  "licenseConsumerId": "f2a72f8c-104a-4fc1-add7-8f1254bce787",
  "usedVersion": "1.7.1.0",
  "distributerId": "20b7abfc-6abb-352e-b1fe-a14b1e507482",
  "licenseKey": "xxxJhbGciOiJodHRwOi8zd3d3LmczLm7yZy8yMDAxLzA0L3htbGRzaWbtbW9zZ...",
  "fiscalCountry": "[0] = Germany",
  "fiscalRegion": null,
  "companyNumber": "003",
  "companyName": "Test Company - DE",
  "companyAddress": {
    "street": "Test Street",
    "streetNumber": "99",
    "postalCode": "10115",
    "city": "Berlin",
    "countryCode": "DEU"
  },
  "companyIdentification": [
    {
      "type": "[0] = VatNumber",
      "identification": "TEST_000000"
    }
  ],
  "companyVatNumber": "TEST_000000",
  "companyTaxNumber": null,
  "fiscalYearStartMonth": 0,
  "storeNumber": "00345",
  "storeName": "Test Store 06 - DE",
  "storeAddress": {
    "street": "Test Street",
    "streetNumber": "1",
    "postalCode": "10115",
    "city": "Berlin",
    "countryCode": "DEU"
  },
  "terminalNumber": "00345",
  "cashRegister": {
    "id": "00000001",
    "brand": "Test Model",
    "modelname": "Model A",
    "serialNumber": "123",
    "currencyIsoCode": "EUR",
    "software": {
      "brand": "Test POS Software",
      "version": "4.40.14",
      "softwareCompany": "Test POS Company"
    }
  },
  "testClient": true,
  "fiscalModulImplementationConfiguration": {
    "primaryTse": {
      "tseDriver": "[99] = xxxxx",
      "tseId": "xxxx....",
      "tseGuid": null,
      "useTseGuid": false,
      "tseParameter": [
        {
          "parameterName": "apiKey",
          "parameterValue": "test_xxx_test"
        },
        {
          "parameterName": "apiSecret",
          "parameterValue": "test_xyz_test"
        },
        {
          "parameterName": "tseAdminPin",
          "parameterValue": "123456"
        },
        {
          "parameterName": "tseAdminPuk",
          "parameterValue": "4099817164"
        },
        {
          "parameterName": "tseMaxClients",
          "parameterValue": ""
        }
      ]
    },
    "fiscalCountry": "[0] = Germany",
    "taxonomyFileStoreConfiguration": {
      "localStorePath": "C:\\ProgramData\\RetailForce\\Fiscal Webservice",
      "compress": true
    },
    "taxonomyCloudStoreConfiguration": null
  },
  "simpleCashPointClosing": true
}

Utilizzo

Questo endpoint viene utilizzato per recuperare informazioni su un client specifico.

Requisiti

RetailForce Fiscal Middleware installato,
il cliente di interesse deve risultare attivato e presente nel sistema locale.

Campi del modulo

È necessario fornire le seguenti informazioni:

Etichetta	Descrizione	Esempi
clientId	L'ID univoco del client da recuperare	aa227e71-6775-45d0-ba73-85da33c34d37

Risposta

Risposte possibili:

Codice	Descrizione	Esempi
200	Richiesta riuscita. Le informazioni relative al clientId richiesto vengono restituite in un oggetto JSON.	FORMATO JSON
422	Il ClientId richiesto non è presente nel sistema locale. Risoluzione dei problemi: Analizzare la causa per cui il client non esiste (più) nel sistema locale.	"Messaggio": "Il client non esiste. (Parametro 'clientId')"
404	Il ClientId richiesto non esiste nel sistema locale. Risoluzione dei problemi: Analizzare la causa per cui il client non è (più) presente nel sistema locale.	"Messaggio": "Non è stata trovata la configurazione del client per aa227e71-6775-45d0-ba73-85da33c34d37."

Questo articolo è stato tradotto automaticamente.

Risultato

Campi del modulo

Risposta

Articoli correlati