WSApCargaDocumentosLista
- Rolando Matheu
- H. Samuel Casuy D.
Este WEB Service, es una extensión de este grupo de API’s REST full, debido a que permite la carga de documentos al expediente electrónico como, Clientes, Créditos y cuentas de ahorro.
Es de suma importancia enviar los parámetros correctos para la conexión, como los parámetros mínimos para que la carga de documentos al expediente electrónico sea exitosa, de lo contrario le mostrará diferentes errores los cuales deberá ir solventando agregando los campos correctos.
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.
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
Este método para este Web Service en específico permite la Creación de Solicitudes de crédito individual en la Aplicación SIFCO WEB.
POST
URL= https://test.sifco.org/sifco/rest/WSApCargaDocumentosLista |
|---|
HEADERS
KEY | VALUE |
|---|---|
Content-Type | application/json |
Authorization | OAuth e12cbbcf-0042-4e30-96b3-c66d356c742b!d39d795cf5d242231636419b57079163144ef487087e5f2142e21dfbbaf66009ef5b7b27404978 |
GENEXUS-AGENT | SmartDevice Application |
BODY
{
"ApDoc_Tipo": 2,
"ApDoc_Clase": 1,
"Llave": "1",
"url": "https://si.ua.es/es/documentos/documentacion/pdf-s/mozilla12-pdf.pdf"
}
NOTA: el VALUE OAuth se debe obtener primero el token de conexión, dirigirse hacia el siguiente documento y seguir las instrucciones.
Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services
Información detallada de los campos a enviar
CAMPO | DESCRIPCIÓN | EJEMPLO |
|---|---|---|
| Este campo representa el código de la configuración que se creo en SIFCO, el cual es de tipo numérico, dicha configuración se vera reflejada en Clientes, Préstamos o cuentas de ahorro, todo según la configuración deseada. |  |
| Este campo representa los tipos de configuración aplicada, por ejemplo si lo queremos aplicar en clientes o en préstamos. |
|
| Este campo puede ser compuesto por un elemento o varios, dependerá del tipo de documento electrónico que necesite cargar. |
|
| Este campo representa la ubicación donde se encuentra el documento. |
Tipos de Clases ("ApDoc_Clase").
Nombre | Descripción | Valor |
|---|---|---|
Cliente | Cliente | 1 |
SolicitudIndividual | Solicitud Individual | 2 |
Garantia | Garantía | 3 |
SolicitudGrupal | Solicitud Grupal | 4 |
Préstamo | Préstamo | 5 |
Ahorros | Ahorros | 6 |
Grupo | Grupo | 7 |
SolicitudCambioBeneficiario | Solicitud Cambio Beneficiario | 8 |
OperacionInusual | Documento para operaciones inusuales | 9 |
ProductoFactoring | Producto de Factoring | 10 |
Tipo de Mensaje HTTP | Ejemplo |
|---|---|
REQUEST | {
"ApDoc_Tipo": 10,
"ApDoc_Clase": 5,
"Llave": "01010110000149",
"url": "https://eqpro.es/wp-content/uploads/2018/11/Ejemplo.pdf"
}
|
200 (Successful operation) Operación Exitosa | {
"Mensaje": "(610) Documento cargado correctamente: 16e7025e-4bb6-4359-8372-551fd5033b54 Content: "
}
|
200 (Successful operation) Operación Exitosa En este caso el número de préstamo no existe |
|
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/WSApCargaDocumentosLista
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
/WSApCargaDocumentosLista- Nombre del WEB SERVICE
Error #2
Cuando existe errores del Token de coneccion.
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 Codigo 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, e4 identificar si son corrects.
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 parametros.
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.