0% encontró este documento útil (0 votos)
15 vistas9 páginas

Conexiones API REST

El documento detalla los endpoints necesarios para la comunicación entre un sistema local y una plataforma web, incluyendo autenticación y operaciones sobre contratos y usuarios. Se especifican métodos HTTP, URLs, parámetros requeridos y ejemplos de consultas en Java. Además, se menciona que las respuestas pueden variar debido a que se encuentra en etapa de desarrollo.

Cargado por

Javier Rios
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 DOCX, PDF, TXT o lee en línea desde Scribd
0% encontró este documento útil (0 votos)
15 vistas9 páginas

Conexiones API REST

El documento detalla los endpoints necesarios para la comunicación entre un sistema local y una plataforma web, incluyendo autenticación y operaciones sobre contratos y usuarios. Se especifican métodos HTTP, URLs, parámetros requeridos y ejemplos de consultas en Java. Además, se menciona que las respuestas pueden variar debido a que se encuentra en etapa de desarrollo.

Cargado por

Javier Rios
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 DOCX, PDF, TXT o lee en línea desde Scribd

CONEXIONES API REST PLATAFORMA WEB / SISTEMA LOCAL

A continuación se definen los endpoints de acceso necesarios para la comunicación entre el


sistema local y la plataforma web.

AUTENTICACIÓN

1- generación de token de autenticación

Para la comunicación correcta con la plataforma web es necesario enviar dentro de cada
solicitud un token de acceso que esté vigente, para obtener este token se generó la
siguiente ruta de autenticación.

NOTA: cada token generado tiene una vigencia de 30 minutos, por lo que se debe
actualizar constantemente para no recibir fallos en las consultas.

Tipo: GET

URL: [Link]

Parámetros:
body:
username : local_sistems
password : 3iHVCFs90FAYKKfJ8o9DcR2

Respuesta:

{
"access_token":"00D36000000bDbI!
AQEAQJQHI555z7zRPC_JcfxAAy5_gulYOzfFY5LKcLj.[Link]
5eclkO5VcL0aGLVpcpPY",
"token_type": "Bearer",
"status": "success"
}

Ejemplo de consulta java

OkHttpClient client = new OkHttpClient().newBuilder()


.build();
MediaType mediaType = [Link]("text/plain");
RequestBody body = new [Link]().setType([Link])
.addFormDataPart("username","local_sistems")
.addFormDataPart("password","3iHVCFs90FAYKKfJ8o9DcR2")
.build();
Request request = new [Link]()
.url("[Link]
.method("POST", body)
.build();
Response response = [Link](request).execute();

ENDPOINTS CONTRATOS

1- inserción de contratos nuevos

URL: [Link]

Tipo: POST

Parámetros:
header:
Authorization : Bearer TOKEN
body:
{
"data":[
{
"idcontrato":234234,
"fcontrato":0,
"idtercero":0,
"fvencimiento":0,
"fmodificacion":0,
"detalle":0,
"tipoarticulo":0,
"estado":0,
"totalcontrato":0,
"totalcantidad":0,
"usuario":0,
"bolsa":0,
"consecutivo":0,
"idconcepto":0,
"porcentaje":0,
"impre":0,
"hora":0
}
]
}

Respuesta:
nota: la respuesta puede variar ya que estamos en etapa de desarrollo
{
"status": "success"
}

Ejemplo de consulta java

OkHttpClient client = new OkHttpClient().newBuilder()


.build();
MediaType mediaType = [Link]("application/json");
RequestBody body = [Link](mediaType, "{\r\n \"data\":[\r\n {\r\n
\"idcontrato\":234234,\r\n \"fcontrato\":0,\r\n \"idtercero\":0,\r\
n \"fvencimiento\":0,\r\n \"fmodificacion\":0,\r\n \"detalle\":0,\r\n
\"tipoarticulo\":0,\r\n \"estado\":0,\r\n \"totalcontrato\":0,\r\
n \"totalcantidad\":0,\r\n \"usuario\":0,\r\n \"bolsa\":0,\r\
n \"consecutivo\":0,\r\n \"idconcepto\":0,\r\n \"porcentaje\":0,\r\n
\"impre\":0,\r\n \"hora\":0\r\n },\r\n {\r\n\r\
n \"idcontrato\":234234,\r\n \"fcontrato\":0,\r\n \"idtercero\":0,\r\n
\"fvencimiento\":0,\r\n \"fmodificacion\":0,\r\n \"detalle\":0,\r\
n \"tipoarticulo\":0,\r\n \"estado\":0,\r\n \"totalcontrato\":0,\r\n
\"totalcantidad\":0,\r\n \"usuario\":0,\r\n \"bolsa\":0,\r\
n \"consecutivo\":0,\r\n \"idconcepto\":0,\r\n \"porcentaje\":0,\r\n
\"impre\":0,\r\n \"hora\":0\r\n }\r\n ]\r\n}");
Request request = new [Link]()
.url("[Link]
.method("POST", body)
.addHeader("Authorization", "Bearer 00D36000000bDbI!
AQEAQNdHQAdOIl_7Sf4ysFQhRdmj_pQ7f80Hnk.Tjf754hKjQHrz17xW3H4Kg2Dwo
pvflASo6paEHZjODJzkes4ltqUC6is2")
.addHeader("Content-Type", "application/json")
.build();
Response response = [Link](request).execute();

2- actualización de contratos

URL: [Link]

Tipo: GET

Parámetros:
header:
Authorization : Bearer TOKEN
URL:
id : id del contrato a buscar (opcional)

Respuesta:
En caso de recibir el campo id devuelve el contrato solicitado o la respuesta de no encontrar
el contrato, en caso de no recibir el id, devuelve el listado de contratos
nota: la respuesta puede variar ya que estamos en etapa de desarrollo
{
"data":[
{
"idcontrato":234234,
"fcontrato":0,
"idtercero":0,
"fvencimiento":0,
"fmodificacion":0,
"detalle":0,
"tipoarticulo":0,
"estado":0,
"totalcontrato":0,
"totalcantidad":0,
"usuario":0,
"bolsa":0,
"consecutivo":0,
"idconcepto":0,
"porcentaje":0,
"impre":0,
"hora":0
},
{
"idcontrato":234234,
"fcontrato":0,
"idtercero":0,
"fvencimiento":0,
"fmodificacion":0,
"detalle":0,
"tipoarticulo":0,
"estado":0,
"totalcontrato":0,
"totalcantidad":0,
"usuario":0,
"bolsa":0,
"consecutivo":0,
"idconcepto":0,
"porcentaje":0,
"impre":0,
"hora":0
}
],
"status": "success"
}
Ejemplo de consulta java

OkHttpClient client = new OkHttpClient().newBuilder()


.build();
MediaType mediaType = [Link]("text/plain");
RequestBody body = [Link](mediaType, "");
Request request = new [Link]()
.url("[Link]
.method("GET", body)
.addHeader("Authorization", "Bearer 00D36000000bDbI!
AQEAQNdHQAdOIl_7Sf4ysFQhRdmj_pQ7f80Hnk.Tjf754hKjQHrz17xW3H4Kg2Dwo
pvflASo6paEHZjODJzkes4ltqUC6is2")
.build();
Response response = [Link](request).execute();

3- confirmación de pagos

URL: [Link]

Tipo: GET

Parámetros:
header:
Authorization : Bearer TOKEN
URL:
id : id del contrato a buscar (opcional)

Respuesta:
En caso de recibir el campo id devuelve el listado de pagos asociado al mismo o la
respuesta de no encontrar pagos, en caso de no recibir el id devuelve el listado de pagos
completo.

nota: la respuesta puede variar ya que estamos en etapa de desarrollo


{
"data":[
{
"idcontrato":234234,
"fcontrato":0,
"idtercero":0,
. . . Información del pago
},
{
"idcontrato":234234,
"fcontrato":0,
"idtercero":0,
. . . Información del pago
}
],
"status": "success"
}

Ejemplo de consulta java

OkHttpClient client = new OkHttpClient().newBuilder()


.build();
MediaType mediaType = [Link]("text/plain");
RequestBody body = [Link](mediaType, "");
Request request = new [Link]()
.url("[Link]
.method("GET", body)
.addHeader("Authorization", "Bearer 00D36000000bDbI!
AQEAQNdHQAdOIl_7Sf4ysFQhRdmj_pQ7f80Hnk.Tjf754hKjQHrz17xW3H4Kg2Dwo
pvflASo6paEHZjODJzkes4ltqUC6is2")
.build();
Response response = [Link](request).execute();

ENDPOINTS USUARIOS

1- inserción de usuarios nuevos

URL: [Link]

Tipo: POST

Parámetros:
header:
Authorization : Bearer TOKEN
body:
{
"data":[
{
"idtercero":124123,
"dv":"test",
"tipodoc":"test",
"expedida":"test",
"nom1":"test",
"nom2":"test",
"ape1":"test",
"ape2":"test",
"nombre":"test",
"dir":"test",
"idmpio":"test",
"idpais":"test",
"telefono":"test",
"tipo":"test",
"profesion":"test",
"fnac":"test",
"estado":"test",
"genero":"test",
"correo":"test",
"fexp":"test",
"rut":"test",
"fact":"test",
"regimen":0
}
]
}

Respuesta:
nota: la respuesta puede variar ya que estamos en etapa de desarrollo
{
"status": "success"
}

Ejemplo de consulta java

OkHttpClient client = new OkHttpClient().newBuilder()


.build();
MediaType mediaType = [Link]("application/json");
RequestBody body = [Link](mediaType, "{\r\n \"data\":[\r\n {\r\n
\"idtercero\":124123,\r\n \"dv\":\"test\",\r\n \"tipodoc\":\"test\",\r\
n \"expedida\":\"test\",\r\n \"nom1\":\"test\",\r\n \"nom2\":\"test\",\r\
n \"ape1\":\"test\",\r\n \"ape2\":\"test\",\r\n \"nombre\":\"test\",\r\n
\"dir\":\"test\",\r\n \"idmpio\":\"test\",\r\n \"idpais\":\"test\",\r\
n \"telefono\":\"test\",\r\n \"tipo\":\"test\",\r\n \"profesion\":\"test\",\r\
n \"fnac\":\"test\",\r\n \"estado\":\"test\",\r\n \"genero\":\"test\",\r\n
\"correo\":\"test\",\r\n \"fexp\":\"test\",\r\n \"rut\":\"test\",\r\
n \"fact\":\"test\",\r\n \"regimen\":0\r\n }\r\n ]\r\n}");
Request request = new [Link]()
.url("[Link]
.method("POST", body)
.addHeader("Authorization", "Bearer 00D36000000bDbI!
AQEAQNdHQAdOIl_7Sf4ysFQhRdmj_pQ7f80Hnk.Tjf754hKjQHrz17xW3H4Kg2Dwo
pvflASo6paEHZjODJzkes4ltqUC6is2")
.addHeader("Content-Type", "application/json")
.build();
Response response = [Link](request).execute();

2- actualización de datos personales

Esta sección se debe conversar ya que no se constante la capacidad de conexión con los
sistemas locales por lo que la plataforma web no puede directamente afectar estos
registros, adicional si se permite un cambio dentro de la información en la plataforma podría
generarse errores de comunicación entre los sistemas.

También podría gustarte