[go: up one dir, main page]
Scribd
Cargar
101 vistas8 páginas

DOCUMENTACION API DOCUMENTO WEB v1

El documento describe una API REST para gestionar documentos en Document Web. Incluye métodos para consultar casos, crear casos, consultar esquemas de imágenes, cargar PDF con imágenes, y cargar imágenes individuales con parámetros como ID de caso, archivos en formato string 64, y ID de imagen.

Cargado por

Rafael Gutierrez C.
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
101 vistas8 páginas

DOCUMENTACION API DOCUMENTO WEB v1

El documento describe una API REST para gestionar documentos en Document Web. Incluye métodos para consultar casos, crear casos, consultar esquemas de imágenes, cargar PDF con imágenes, y cargar imágenes individuales con parámetros como ID de caso, archivos en formato string 64, y ID de imagen.

Cargado por

Rafael Gutierrez C.
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 8

SOLFINANZAS DE COLOMBIA SAS

Ing. Rafael Gutiérrez Correales


ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

API REST DOCUMENT WEB


Versión 1.0
Enero 12 de 2021

Página | 1
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

1. API REST DOCUMENT WEB

1.1 ConsultarCaso
METODO: GET

Descripción:
Permite obtener el estado de una solicitud, previamente radicada en
Document Web.

Ejemplo URL para consumo:


http://xxx.xxx.xx.xx/api/caso/2062252

Parámetros de entrada:
Nombre Tipo Valor
id integer Número entero de 7
dígitos.

Definiciones:
Nombre Descripción
id Id del caso a consultar.

Respuesta:
Nombre Descripción
JSON {
"sucess": true,
"data": {
"ConsultarCasoResult": null
},
"message": ""
}

Página | 2
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

1.2 CrearCaso
METODO: POST

Descripción:
Permite radicar una solicitud en Document Web.

Ejemplo URL para consumo:


http://xxx.xxx.xx.xx/api/caso

Parámetros de entrada:
Nombre Tipo Valor
JSON JSON {
"id" : 333
}

Definiciones:
Nombre Descripción
id Número de identificación del tercero, al cual se le
radicará la solicitud.

Respuesta:
Nombre Descripción
JSON {
"sucess": true,
"data": "333-2062313",
"message": "Ok. Caso radicado!"
}

Anotaciones:

El key “data” en el JSON de respuesta; se almacena separados por el carácter


“-” el número de identificación enviado, seguido del número de la solicitud
radicada.

Página | 3
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

1.3 ConsultarImagenes
METODO: GET

Descripción:
Permite obtener el esquema de imágenes, de una solicitud radicada en
Document Web.

Ejemplo URL para consumo:


http://xxx.xxx.xx.xx/api/image/2062252

Parámetros de entrada:
Nombre Tipo Valor
id integer Número entero de 7
dígitos.

Definiciones:
Nombre Descripción
id Número de solicitud.

Respuesta:
Nombre Descripción
JSON {
"sucess": true,
"data": {
"ConsultarImagenesResult": {
"schema": {
"attributes": {
"id": "NewDataSet"
},
"element": {
"attributes": {
"name": "NewDataSet",
"msdata:IsDataSet": "true",

Página | 4
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

"msdata:UseCurrentLocale": "true"
},
"complexType": {
"choice": {
"attributes": {
"minOccurs": "0",
"maxOccurs": "unbounded"
}
}
}
}
},
"diffgram": null
}
},
"message": ""
}

Página | 5
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

1.4 CargarPdf
METODO: POST
Descripción:
Permite cargar un archivo PDF con todas las imágenes correspondientes a la
validación documental.

Ejemplo URL para consumo:


http://xxx.xxx.xx.xx/api/image/pdf

Parámetros de entrada:
Nombre Tipo Valor
JSON JSON {
"idCaso" : 2062252,
"PdfString64" :
"iVBORw0KGgoAAAANSUhEUg
AAAAEAAAABAQMAAAAl21bK
AAAAA1BMVEUAAACnej3aAAA
AAXRSTlMAQObYZgAAAApJREF
UCNdjYAAAAAIAAeIhvDMAAAA
ASUVORK5CYII="
}

Definiciones:
Nombre Descripción
idCaso Número de la solicitud.

PdfString64 Archivo PDF que contiene las imágenes en binario.


Formato 64 bytes.

Respuesta:
Nombre Descripción
JSON {
"sucess": true,
"data": [],
"message": "Ok. Documento radicado!"
}

Página | 6
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

1.5 CargarImagen
METODO: POST

Descripción:
Permite cargar una imagen correspondiente a la validación documental.

Ejemplo URL para consumo:


http://xxx.xxx.xx.xx/api/image/image

Parámetros de entrada:
Nombre Tipo Valor
JSON JSON {
"idCaso" : 2062252,
"ImgString64" :
"iVBORw0KGgoAAAANSUhEUgAAA
AEAAAABAQMAAAAl21bKAAAAA1
BMVEUAAACnej3aAAAAAXRSTlMA
QObYZgAAAApJREFUCNdjYAAAAAI
AAeIhvDMAAAAASUVORK5CYII=",
"idImage" : 1
}

Definiciones:
Nombre Descripción
idCaso Número de la solicitud.

ImgString64 Archivo de imagen en binario. Formato 64 bytes.

idImage Id correspondiente al tipo de imagen y se codifica de acuerdo


a la siguiente tabla:

Código Tipo Descripción


1 integer Anverso del documento.
2 integer Reverso del documento.
3 integer Fotocopia del documento.
4 integer Foto.
5 integer Firma.
6 integer Huella1
7 integer Huella2

Página | 7
SOLFINANZAS DE COLOMBIA SAS
Ing. Rafael Gutiérrez Correales
ing.rafael.gutierrez.correales@gmail.com
sistemas@solfinanzas.co

Respuesta:
Nombre Descripción
JSON {
"sucess": true,
"data": [],
"message": "Ok. Imagen radicada!"
}

Página | 8

También podría gustarte