AR Server - Servicios SMB

Servicio: obtener token (authenticate)

Expandir

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

Elemento

Descripción

Tipo de dato

Requerido

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

String

Sí

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.

String

Sí

Ejemplo:

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

RESPONSE OK

Elemento	Tipo	Detalle
token	String	Token de seguridad devuelto por el sistema.
expiresIn	Number	Tiempo de expiración del token medido en unidad de expiración.
expUnit	String	Unidad de expiración.

Ejemplo:

{
"token":

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNWU5NDczZGU4YTk2NDI5MzlkMzVkYzhiIn0sImlhdCI6MTU5NTk0NzkyOSwiZXhwIjoxNTk1OTUxNTI5fQ.yrMsmYgyPtii59moYgujKE96ZeFNhHuZnwt3OeE59fM"

,
"expiresIn": 3600000,
"expUnit": "miliseconds"
}

RESPONSE ERROR

Elemento

Tipo

Detalle

ack

Number

Código de error. Siendo los valores posibles:

Requirement
freetext Link
type LINK
key FF-2001
"Invalid credentials format": Verificar que se estén todos los datos obligatorios.
Requirement
freetext Link
type LINK
key FF-2002
"Credenciales invalidas"
Requirement
freetext Link
type LINK
key FF-2999
"Internal Server Error"
Requirement
freetext Link
type LINK
key FF-3999

message

String

Detalle del tipo del error.

Ejemplo:

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

Servicio: alta de compañía (newCompany)

Expandir

title	Servicio: Autorizar terminal (authenticate)

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

Elemento	Descripción	Tipo de dato	Requerido	Validaciones
adminUser	Usuario administrador a generar en FiscalFlow	String	SI
adminPass	Password del usuario administrador a generar en FiscalFlow	String	SI	La contraseña debe contener mínimo 8 caracteres y máximo 100, al menos 1 letra mayúscula y no se permiten espacios.
code	Código de compañía a dar de alta	String	Si	El código de compañía no puede contener espacios.
name	Nombre o Razón social de la compañía a dar de alta	String	Si
identificationNumber	Numero de identificación de la compañía	String	Si	El número de identificación debe consistir de 11 caracteres
iibbNumber	Nro. de IIBB de la compañia	String	Si
testMode	Indica en que modo operara la compañía: Test = true Producción = false	Boolean	Si
province	Provincia de la compañía	String	Si
city	Ciudad de la compañia	String	Si
address	Dirección Legal de la compañía	String	Si
taxCategory	Categoría impositiva de la compañía	Number	Si	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
email	Email de la compañía	String	No
phone	Nro. de telefono de la compañia	String	No
unit	Rubro de la compañía	String	No

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
ack	Number	Valor "0"
message	String	Valor "OK"
clientId	String
clientSecret	String

Ejemplo:

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

"clientId": "adasdasda",

"clientSecret": "redasdq"
}

RESPONSE ERROR

Elemento	Tipo	Detalle
ack	Number	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
message	String	Detalle del tipo del error.

Ejemplo:

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

Servicio: alta de tienda(newStore)

Expandir

title	Servicio: Autorizar terminal (authenticate)

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

Elemento	Descripción	Tipo de dato	Requerido	Validaciones
companyCode	Código de compañía a dar de alta	String	Si
code	Código de Tienda a dar de alta	String	Si	El código de Tienda no puede contener espacios.
name	Nombre de la tienda	String	Si
address	Dirección Fiscal de la Tienda	String	Si
province	Provincia de la compañía	String	Si
city	Ciudad de la compañia	String	Si
stablishmentNumber	Numero de establecimiento	String	No

Ejemplo:

{

"companyCode":"napse",

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

RESPONSE OK

Elemento	Tipo	Detalle
ack	Number	Valor "0"
message	String	Valor "OK"

Ejemplo:

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

RESPONSE ERROR

Elemento	Tipo	Detalle
ack	Number	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.
message	String	Detalle del tipo del error.

Ejemplo:

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

Servicio: alta de Terminal(newTerminal)

Expandir

title	Servicio: Autorizar terminal (authenticate)

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

Elemento	Descripción	Tipo de dato	Requerido	Validaciones
companyCode	Código de compañia	String	Si
storeCode	Código de Tienda	String	Si
code	Código de la terminal a dar de alta	String	Si	El código de la terminal no puede contener espacios.
name	Nombre de la terminal	String	Si

Ejemplo:

{

"companyCode":"napse",

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

}

RESPONSE OK

Elemento	Tipo	Detalle
ack	Number	Valor "0"
message	String	Valor "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
ack	Number	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
message	String	Detalle del tipo del error.

Ejemplo:

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

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

AR Server - Servicios SMB

Servicio: obtener token (authenticate)

POST - REQUEST

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de compañía (newCompany)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de tienda(newStore)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de Terminal(newTerminal)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

AR Server - Servicios SMB

Servicio: obtener token (authenticate)

POST - REQUEST

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de compañía (newCompany)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de tienda(newStore)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR

Servicio: alta de Terminal(newTerminal)

POST - REQUEST

header

BODY

RESPONSE OK

RESPONSE ERROR