AR Server - Servicios SMB

Servicio: obtener token (authenticate)

Servicio de seguridad que permite a una terminal ser autorizada para utilizar el restos de los servicios del sistema.

Este servicio requiere que se brinden las claves de acceso (un id y un secret), el cual estarán configurados en parámetros de configuración de fiscalFlow

Retornará un token, el cual es requerido al invocar los servicios de negocio.


Es un método REST basado en el formato JSON. Ejemplo: 

[post] http://[dirección-ip]:[puerto]/api/v1/installer/authenticate

POST - REQUEST

BODY

ElementoDescripciónTipo de datoRequerido
clientId

Credenciales para el uso de la aplicación. Se obtienen de la consola, sección Administración> Configuración, en el parámetro multicompañía del tipo server installClientId

Identifica al usuario

StringSí
clientSecret

Credenciales para el uso de la aplicación. Se obtienen de la consola, sección Administración> Configuración, en el parámetro multicompañía del tipo server installClientSecret

Identifica a la contraseña del usuario.

StringSí

Ejemplo:

{
    "clientId":"vcn5keiiw0zf",
    "clientSecret":"g23n2tlt3fmap0ymaosv"
}

RESPONSE OK

ElementoTipoDetalle
tokenStringToken de seguridad devuelto por el sistema.
expiresInNumber

Tiempo de expiración del token medido en unidad de expiración.

expUnit

StringUnidad de expiración.

Ejemplo:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNWU5NDczZGU4YTk2NDI5MzlkMzVkYzhiIn0sImlhdCI6MTU5NTk0NzkyOSwiZXhwIjoxNTk1OTUxNTI5fQ.yrMsmYgyPtii59moYgujKE96ZeFNhHuZnwt3OeE59fM",
  "expiresIn": 3600000,
  "expUnit": "miliseconds"
}

RESPONSE ERROR

ElementoTipoDetalle
ackNumber

Código de error. Siendo los valores posibles:

  • FF-2001 "Invalid credentials format": Verificar que se estén todos los datos obligatorios.
  • FF-2002 "Credenciales invalidas"
  • FF-2999 "Internal Server Error" FF-3999
messageStringDetalle del tipo del error.

Ejemplo:

{
    "ack": 2002,
    "message": "User not found"
}

Servicio: alta de compañía (newCompany)

Servicio por el cual se podrá dar de alta una compañía en Fiscal Flow.

Para el uso del servicio es necesario informar un token que se obtiene a través del servicio "Authenticate".

Es un método REST basado en el formato JSON. Ejemplo: 

[post] http://[dirección-ip]:[puerto]/api/v1/installer/newCompany

POST - REQUEST

header

Elemento

Valor

x-access-token
Token obtenido a través del servicio "Authenticate"

Ejemplo:

x-access-token:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE

BODY

ElementoDescripciónTipo de datoRequeridoValidaciones
adminUser
    		Usuario administrador a generar en FiscalFlowStringSI
adminPassPassword del usuario administrador a generar en FiscalFlowStringSI La contraseña debe contener mínimo 8 caracteres y máximo 100, al menos 1 letra mayúscula y no se permiten espacios.
codeCódigo de compañía a dar de altaStringSiEl código de compañía no puede contener espacios.
nameNombre o Razón social de la compañía a dar de altaStringSi
identificationNumberNumero de identificación de la compañíaStringSiEl número de identificación debe consistir de 11 caracteres
iibbNumberNro. de IIBB de la compañiaStringSi
testMode

Indica en que modo operara la compañía:

Test = true

Producción = false

BooleanSi
provinceProvincia de la compañíaStringSi
cityCiudad de la compañiaStringSi
addressDirección Legal de la compañíaStringSi
taxCategoryCategoría impositiva de la compañíaNumberSi

Los valores permitidos son los siguientes, se deberá enviar solo el código:

Código  Descripción
1            IVA Responsable Inscripto
2            IVA Responsable no Inscripto
3            IVA no Responsable
4            IVA Sujeto Exento
5            Consumidor Final
6            Responsable Monotributo
7            Sujeto no Categorizado
8            Proveedor del Exterior
9            Cliente del Exterior
10          IVA Liberado – Ley Nº 19.640
11          IVA Responsable Inscripto – Agente de Percepción
12          Pequeño Contribuyente Eventual
13          Monotributista Social
14          Pequeño Contribuyente Eventual Social

emailEmail de la compañíaStringNo
phoneNro. de telefono de la compañiaStringNo
unitRubro de la compañíaStringNo

Ejemplo:

{

     "adminUser":"test",

     "adminPass":"Prueba123456",
    "code": "napse",
    "name": "Compañia napse",
    "identificationNumber": "13213213432",
    "iibbNumber": "1334123",
    "testMode": false,
    "province":"Buenos aires",
    "city":"Moron",
    "address":"Alem 123",
    "taxCategory":1,
    "email":"napse@napse.com",
    "phone":"0800-111-111",
    "unit":"Retail"
}

RESPONSE OK

Elemento

Tipo

Detalle

ackNumber

Valor "0"

messageStringValor "OK"
clientIdString
clientSecretString

Ejemplo:

{
    "ack": 0,
    "message": "Ok",

     "clientId": "adasdasda",

     "clientSecret": "redasdq"
}

RESPONSE ERROR

Elemento

Tipo

Detalle

ackNumber

Código de error. Siendo los valores posibles:

  • 2004: Access token is missing
  • 2005: Access token does not exists
  • 3999: JSON mal formado
  • 2900: [Campo ] tipo de dato invalido
  • 2100: Error de validación: [Campo] is missing
  • 2050: Categoría impositiva invalida.
  • 2051: Código de compañía ingresado ya existe
  • 2052: Nro. identificación compañía ingresado ya existe
  • 2053: El número de identificación debe consistir de 11 caracteres
  • 2054: El código de compañía no puede contener espacios.
  • 2055: adminPass: La contraseña debe contener mínimo 8 caracteres y máximo 100, al menos 1 letra mayúscula y no se permiten espacios
messageStringDetalle del tipo del error.


Ejemplo:

{
    "ack": 2004,
    "message": "Access token is missing"
}

Servicio: alta de tienda(newStore)

Servicio por el cual se podrá dar de alta una Tienda en Fiscal Flow.

Para el uso del servicio es necesario informar un token que se obtiene a través del servicio "Authenticate".

Es un método REST basado en el formato JSON. Ejemplo: 

[post] http://[dirección-ip]:[puerto]/api/v1/installer/newStore

POST - REQUEST

header

Elemento

Valor

x-access-token
Token obtenido a través del servicio "Authenticate"

Ejemplo:

x-access-token:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE

BODY

ElementoDescripciónTipo de datoRequeridoValidaciones
companyCodeCódigo de compañía a dar de altaStringSi
codeCódigo de Tienda a dar de altaStringSiEl código de Tienda no puede contener espacios.
nameNombre de la tiendaStringSi
addressDirección Fiscal de la TiendaStringSi
provinceProvincia de la compañíaStringSi
cityCiudad de la compañiaStringSi
stablishmentNumberNumero de establecimientoStringNo

Ejemplo:

{

     "companyCode":"napse",

     "code":"T1",
    "name": "Tienda 1",
    "address":"Alem 123",
    "province":"Buenos aires",
    "city":"Moron",
    "stablishmentNumber":1
}

RESPONSE OK

Elemento

Tipo

Detalle

ackNumber

Valor "0"

messageStringValor "OK"

Ejemplo:

{
    "ack": 0,
    "message": "Ok"
}

RESPONSE ERROR

Elemento

Tipo

Detalle

ackNumber

Código de error. Siendo los valores posibles:

  • 2004: Access token is missing
  • 2005: Access token does not exists
  • 3999: JSON mal formado
  • 2900: [Campo ] tipo de dato invalido
  • 2100: Error de validación: [Campo] is missing
  • 2056: Código de Tienda ingresado para la compañía ya existe.
  • 2057: El código de tienda no puede contener espacios.
  • 2058: La compañía de la tienda a dar de alta no existe.
messageStringDetalle del tipo del error.


Ejemplo:

{
    "ack": 2004,
    "message": "Access token is missing"
}

Servicio: alta de Terminal(newTerminal)

Servicio por el cual se podrá dar de alta una Terminal en Fiscal Flow.

Para el uso del servicio es necesario informar un token que se obtiene a través del servicio "Authenticate".

Es un método REST basado en el formato JSON. Ejemplo: 

[post] http://[dirección-ip]:[puerto]/api/v1/installer/newTerminal

POST - REQUEST

header

Elemento

Valor

x-access-token
Token obtenido a través del servicio "Authenticate"

Ejemplo:

x-access-token:  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE

BODY

ElementoDescripciónTipo de datoRequeridoValidaciones
companyCodeCódigo de compañiaStringSi
storeCodeCódigo de TiendaStringSi
codeCódigo de la terminal a dar de altaStringSiEl código de la terminal no puede contener espacios.
nameNombre de la terminalStringSi

Ejemplo:

{

     "companyCode":"napse",

     "storeCode":"T1",
    "code": "TT1",
    "name": "Terminal 1",
    
}

RESPONSE OK

Elemento

Tipo

Detalle

ackNumber

Valor "0"

messageStringValor "Recuerde ingresar a la consola de fiscal flow para completar los puntos de venta en la terminal para poder operar."

Ejemplo:

{
    "ack": 0,
    "message": "Recuerde ingresar a la consola de fiscal flow para completar los puntos de venta en la terminal para poder operar."
}

RESPONSE ERROR

Elemento

Tipo

Detalle

ackNumber

Código de error. Siendo los valores posibles:

  • 2004: Access token is missing
  • 2005: Access token does not exists
  • 3999: JSON mal formado
  • 2900: [Campo ] tipo de dato invalido
  • 2100: Error de validación: [Campo] is missing
  • 2059: La compañía de la terminal a dar de alta no existe
  • 2060: Código de terminal ingresado para la tienda ya existe.
  • 2061: El código de terminal no puede contener espacios.
  • 2062: La Tienda de la terminal a dar de alta no existe
messageStringDetalle del tipo del error.


Ejemplo:

{
    "ack": 2004,
    "message": "Access token is missing"
}

  • Sem rótulos