Lectura de tarjetas de contacto para extraer los posibles campos de la misma
Peticion
Tipo |
Url |
Descripción |
POST |
https://paellacode.com:8443/ocr/V1/basic/user/create |
Crea al usuario que va a usar el servicio |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
Content-Type |
application/json |
Body
Parámetro |
Requerido |
Tipo |
Descripción |
idUserExt |
Sí |
String |
Identificador único del usuario del desarrollador |
Respuesta
Parámetro |
Tipo |
Descripción |
idUser |
String |
Identificador único del usuario |
idUserExt |
String |
Identificador único del usuario del desarrollador |
idProject |
String |
Identificador del proyecto al que pertenece el usuario |
Crea al usuario
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/user/create",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json"
},
"data": "{\n\t\"idUserExt\":\"10\"\n}",
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Peticion
Tipo |
Url |
Descripción |
GET |
https://paellacode.com:8443/ocr/V1/basic/user |
Devuelve el usuario actual |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
Respuesta
Parámetro |
Tipo |
Descripción |
idUser |
String |
Identificador único del usuario |
idUserExt |
String |
Identificador único del usuario del desarrollador |
idProject |
String |
Identificador del proyecto al que pertenece el usuario |
Devuelve el usuario actual
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/user",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Peticion
Tipo |
Url |
Descripción |
POST |
https://paellacode.com:8443/ocr/V1/basic/consulta |
Genera una nueva consulta OCR |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
Body
Parámetro |
Requerido |
Tipo |
Descripción |
file |
No |
MultipartFile |
Imagen digital a consultar por el OCR |
base64 |
No |
String |
Contiene el base64 de la imagen a consultar por el OCR |
storage |
No |
boolean |
Indica si tiene que almacenar la imagen |
Respuesta
Parámetro |
Tipo |
Descripción |
jsonOCR |
Map<String,Object> |
Respuesta original al realizar el OCR |
emails |
Array[String] |
Lista con los emails localizados en la imagen |
phones |
Array[String] |
Lista con los teléfonos localizados en la imagen |
organizations |
Array[String] |
Lista con las organizaciones localizadas en la imagen |
webs |
Array[String] |
Lista con las webs localizadas en la imagen |
idConsulta |
Number |
Identificador único cuando se almacena la imagen |
Devuelve datos de una imagen
var form = new FormData();
form.append("file", "/C:/Users/Equipo/Desktop/tarjetas ocr/IMG_20190917_125656~01 (2).png");
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/consulta",
"method": "POST",
"timeout": 0,
"processData": false,
"mimeType": "multipart/form-data",
"contentType": false,
"data": form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Peticion
Tipo |
Url |
Descripción |
GET |
https://paellacode.com:8443/ocr/V1/basic/consulta/{idConsulta} |
Obtiene la imagen asociada a la consulta |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
URL
Parámetro |
Descripción |
idConsulta |
Identificador único de una consulta que ha almacenado la imagen |
Respuesta
Tipo |
Descripción |
Binary |
Contenido del fichero |
Descarga la imagen
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/consulta/2",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Peticion
Tipo |
Url |
Descripción |
DELETE |
https://paellacode.com:8443/ocr/V1/basic/consulta/{idConsulta} |
Elimina la consulta realizada por el usuario |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
URL
Parámetro |
Descripción |
idConsulta |
Identificador único de una consulta que ha almacenado la imagen |
Respuesta
Parámetro |
Tipo |
Descripción |
delete |
boolean |
Indica si el fichero ha sido eliminado |
Elimina la imagen
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/consulta/1",
"method": "DELETE",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Peticion
Tipo |
Url |
Descripción |
GET |
https://paellacode.com:8443/ocr/V1/basic/consulta/all |
Obtiene las consultas del usuario que han almacenado la imagen |
Header
Parámetro |
Descripción |
Authorization |
Bearer JWT |
Respuesta
Parámetro |
Tipo |
Descripción |
idConsulta |
Number |
Identificador único de la consulta |
jsonOCR |
String |
Contiene la respuesta original al realizar el OCR |
Devuelve las consultas del usuario actual
var settings = {
"url": "https://paellacode.com:8443/ocr/V1/basic/consulta/all",
"method": "GET",
"timeout": 0,
};
$.ajax(settings).done(function (response) {
console.log(response);
});