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

Este punto final devuelve información sobre un clientId específico. Se utiliza para recuperar datos sobre un cliente concreto, entre los que se incluyen:

Datos de identificación únicos del cliente
Información sobre la licencia
Datos de la empresa
Datos comerciales
Información del punto de venta
Varios parámetros

Importante: se debe verificar que el clientId exista en el sistema local. De no ser así, el sistema devolverá el error «El cliente no existe. (Parámetro 'clientId')». Puede ser necesario realizar un análisis más detallado para determinar la razón por la cual el clientId no está presente en el sistema local. Si el cliente aún no ha sido puesto en funcionamiento, deberá activarse en primer lugar.

Resultado

Una llamada correcta al punto final devuelve una respuesta HTTP 200 y un objeto JSON que contiene la información solicitada sobre el cliente.

Ejemplo:

{
  "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
}

Uso

Este punto final se utiliza para recuperar información sobre un cliente específico.

Requisitos

RetailForce Fiscal Middleware instalado,
el cliente correspondiente debe estar activado y presente en el sistema local.

Campos del formulario

Es necesario proporcionar la siguiente información:

Etiqueta	Descripción	Ejemplos
clientId	El identificador del cliente a recuperar	aa227e71-6775-45d0-ba73-85da33c34d37

Respuesta

Respuestas posibles:

Código	Descripción	Ejemplos
200	Solicitud realizada con éxito. La información correspondiente al clientId solicitado se devuelve en un objeto JSON.	FORMATO JSON
422	El ClientId solicitado no existe en el sistema local. Solución de problemas: Analice la causa por la que el cliente ya no existe en el sistema local.	«Mensaje»: «El cliente no existe. (Parámetro 'clientId')»
404	El ClientId solicitado no existe en el sistema local. Solución de problemas: Analice la causa por la que el cliente ya no existe en el sistema local.	«Mensaje»: «No se ha encontrado la configuración del cliente para aa227e71-6775-45d0-ba73-85da33c34d37.»

Este artículo ha sido traducido automáticamente.

Resultado

Campos del formulario

Respuesta

Artículos relacionados