WsFechaModulosSIFCO
- H. Samuel Casuy D.
Este Web Service WsFechaModulosSIFCO, es utilizado para consultar la fecha en la que se encuentra el sistema para los módulos de Captaciones, Colocaciones, Caja, Clientes, Mayor General o Punto de Venta, adicional nos retorna la fecha siguiente y la anterior. Este Web Service incluye entre los campos de respuesta si el cliente esta operando en fines de semana (Sábado - Domingo).
Campos para el consumo del servicio y respuestas:
CAMPO | VALOR | DESCRIPCIÓN |
|---|---|---|
Modo | Carácter
| DSP: representa la consulta de un modulo y empresa en especifico TDO: representa la consulta de todos los módulos y empresas |
CodigoEmpresa | Numérico | Para el modo DSP es necesario enviar los valores de empresa y modulo. Para el modo TDO se pueden enviar los valores vacíos. |
Modulo | Carácter
| Este campo nos permite consultar un módulo en especifico del sistema. |
| Json (LongVarchar) | Colección de mensajes de error o exitosos |
| Carácter | Respuesta de éxito o de error de la consulta de los datos. |
| Json (LongVarchar) | Nos retorna los datos de la consulta del modulo o de todos lo módulos del sistema |
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTPS.
La herramienta utilizada para realizar pruebas de conexión es POSTMAN. A continuación se mostraran los parámetros de conexión.
EL MÉTODO A UTILIZAR ES DE TIPO POST
El método para este Web Service en específico nos permite consultar la lista fechas de los módulos del sistema y validar la fecha en que se encuentra el misma.
POST
URL= |
|---|
NOTA: recuerde siempre consultar la URL de conexión, la antes mencionada es referencial
HEADERS
KEY | VALUE |
|---|---|
Content-Type | application/json |
Authorization | OAuth e12cbbcf-0042-4e30-96b3-c66d356c742b!d39d795cf5d242231636419b57079163144ef487087e5f2142e21dfbbaf66009ef5b7b27404978 |
GENEXUS-AGENT | SmartDevice Application |
BODY
{
"Modo": "DSP",
"CodigoEmpresa": "1",
"Modulo": "CO"
}
NOTA: el VALUE OAuth se debe obtener primero el token de conexión, dirigirse hacia el siguiente documento y seguir las instrucciones.
PARÁMETRO | VALOR | DESCRIPCIÓN |
|---|---|---|
| “DSP“ | Modo de la consulta de datos único. |
| “TDO“ | Modo de la consulta de datos generales |
| “1“ | Código de la empresa |
| “CA” “CO” “CL” “CJ” | Tipo de modulo de consulta CA: Captaciones CO: Colocaciones CL: Clientes CJ: Caja |
Consumo del servicio de forma exitosa:
Consulta 1:
{
"Modo": "DSP",
"CodigoEmpresa": "1",
"Modulo": "CO"
}Resultado:
{
"FechasModulosSIFCO_SDT": [
{
"CodigoEmpresa": 1,
"Modulo": "CO",
"ModuloDescripcion": "COLOCACIONES",
"FechaSistema": "2024-04-01",
"FechaSiguiente": "2024-04-02",
"FechaAnterior": "2024-03-31",
"FechaCierre": "2024-04-30",
"ModuloEstado": "O",
"OperaSabado": "S",
"OperaDomingo": "S",
"CorrelativoPartidas": 0,
"ModuloDireccionRutina": "",
"NombreProgramaEjecutabe": ""
}
],
"Messages": [
{
"Id": "",
"Type": 2,
"Description": "(1085) La consulta fue exitosa"
}
],
"Respuesta": "SUCCESS"
}
Consulta 2:
Consumo del servicio de forma Errónea:
Error #1
Cuando la URL no se agrego correctamente.
El código de error será 404 not Found, con el siguiente mensaje:
“No se pudo encontrar el recurso solicitado, pero es posible que vuelva a estar disponible en el futuro. Se permiten solicitudes posteriores por parte del cliente.“
La URL esta compuesta de la siguiente manera:
https://test.sifco.org/Instancia/rest/WsFechaModulosSIFCO
https://test.sifco.org - el nombre del dominio (según lo proporcionado por SIFCO).
/Instancia - El nombre de la instancia instalada en el servidor de SIFCO.
/rest - nombre del parámetro con el que se ingresa
/WsFechaModulosSIFCO - Nombre del WEB SERVICE
Error #2
Cuando existe errores del Token de conexión.
El código de error es 401 Token no encontrado
“Similar a 403 Forbidden, pero específicamente para usar cuando la autenticación es posible pero ha fallado o aún no se ha proporcionado. La respuesta debe incluir un campo de encabezado WWW-Authenticate que contenga un desafío aplicable al recurso solicitado.”
Token invalido o modificado
Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services ), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST.
Ejemplo:
Error #3
Mala configuración de encabezados (Headers).
El Código de error es 401 This service needs an Authorization Header
“Similar to 403 Forbidden, but specifically for use when authentication is possible but has failed or not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.”
Revisar los Headers, e identificar si son correctos.
Ejemplo:
Error #4
Servicios web no disponibles.
El Código de error es 500, indica que los servicios no están disponibles. Consultar a SIFCO, si en caso los servidores no están disponibles o la instancia no fue instalada correctamente.
Error #5
Errores por parámetros.
revisar cada parámetro enviado, existen varios errores en cuanto a los datos que no se envían correctamente, la respuesta se muestra al final del Json indicando cual fue el error percibido.
(c) 2020 por SIFC.O, S.A.