Napse > FleetManager Agente - Servicios Generales > logo_fiscalflow.png

FleetManager Agente - Servicios Generales

SECUENCIA DE EJECUCIÓN DE SERVICIOS
Secuencia	Descripción	Resultado
1	Solicitar a SAC una registerKey para poder registrar la compañía.
2	Llamar al servicio registerCompany de Fleet manager según el modelo del manual de integración	IMPORTANTE Este servicio les devolverá un clientId y un clientSecret, el cual deberán guardar para luego usarlo en el servicio Autenthicate, el cual les devolverá un token Valido para operar con los demás servicios de Fleet Manager.
3	Llamar al servicio authenticate segun el modelo del manual de integracion, con el clientId y clientSecret obtenido en el paso anterior	Les devolverá un Token que les servirá para poder operar con los demás servicios de Fleet Manager.
4	Podrán llamar al servicio getFleetOperators según el modelo del manual de integración, para obtener los operadores de flota disponibles (SIGAF en este caso).	Operadores de flota habilitados a operar con Fleet Manager.
5	Llamar al servicio registerPreAuthorization según el modelo del manual de integración.	Si pasa todas las validaciones devolverá un ack = 0 con message = "OK", caso contrario les devolverá error con su respectivo código y mensaje
6	Podrán llamar al servicio confirmation o reverse según el modelo del manual de integración.	Si pasa todas las validaciones devolverá un ack = 0 , caso contrario les devolverá error con su respectivo código y mensaje

Servicio: Autenticar (authenticate)

Servicio de seguridad que permite a un sistema cliente obtener una clave de autorización de uso (token) de los servicios del sistema.

Este servicio requiere que se brinden las claves de acceso (un clientId y un clientSecret).

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/oauth2/authenticate

POST - REQUEST

BODY

clientId	Envía el valor clientId
clientSecret	Envía el valor clientSecret

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	: Formato de credenciales inválidos : Faltan las credenciales de solicitud : Estructura del JSON invalida : Error de comunicación con el servidor
message	String	Detalle del tipo del error.

Ejemplo:

{

"ack": 3001,

"message": "Formato de credenciales inválidos."

}

Servicio: Registrar Compañia (registerCompany)

Servicio por el cual se podrán registrar compañías para luego poder operar con todos los servicios expuestos por el agente de fleet manager.

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

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

POST - REQUEST

BODY

Elemento	Descripcion	Tipo	Requerido
code	Código de compañía, provisto para la empresa que contrata el servicio.	String	SI
name	Nombre de la compañia	String	SI
identificationNumber	Cuit de la Compañia	String	SI
registerKey	Codigo valido para registrar compañia	string	SI

Ejemplo:

{

"code": "napse",

"name": "Napse Global",

"identificationNumber" : "27388551854",

"registerKey" : "sad1231asff24124sda"

}

RESPONSE OK

Elemento	Descripcion	Tipo	Requerido
ack	Código del Response	number	SI
message	Mensaje del Response	String	SI
clientID	Client ID	string	SI
clientSecret	Client Secret	String	SI

Ejemplo:

{

" ack" : 0,

" message" : "OK" ,

"clientid" : "dwqxqxqqw",

"clientsecret" : "121e12dqwdsda"

}

RESPONSE ERROR

Elemento

Tipo

Detalle

ack

Number

Código de error. Siendo los valores posibles:

: Estructura del JSON invalida

: Error de Validacion: [Campo Faltante] es Requerido

: RegisterKey Invalido

: No tiene Acceso al servicio solicitado

: Registro duplicado [Campo][Valor]

: Error de comunicación con el servidor

message

String

Detalle del tipo del error.

Ejemplo:

{

"ack": 3008,

"message": "Estructura del JSON invalida."

}

Servicio: Obtener Operadores de Flota (getFleetOperators)

Servicio por el que se puede consultar los Operadores de Flota habilitados por fleet Manager.

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

[get] http://[dirección-ip]:[puerto]/api/v1/getFleetOperators

GET – REQUEST

HEADER

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

Ejemplo:

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

RESPONSE

Elemento	Descripcion	Tipo	Requerido
code	Código del operador de flota	String	SI
name	Descripción del operador de flota	String	SI

Ejemplo:

[

{

"code":"SG",

"name":"SIGAF"

},

{

"code":"AT",

"name":"ATIONET"

}

]

RESPONSE ERROR

Elemento	Tipo	Detalle
ack	Number	Código de error. Siendo los valores posibles: : Se debe enviar un Access Token : Access Token invalido : Error de comunicación con el servidor
message	String	Detalle del tipo del error.

Ejemplo:

{

"ack": 3003,

"message": "Access Token invalido"

}