Está en la página 1de 13

Sistema de Identificación

HOJA DE CONTROL

ORGANISMO | RENAPER
PROYECTO | SID – Sistema de identificación
ENTREGABLE | Documento de especificación de interfaz
AUTOR | Registro Nacional de las Personas – Ministerio del Interior
FECHA | DD/MM/AAAA

REGISTRO DE CAMBIOS

VERSIÓN
1.4

DESCRIPCIÓN
Versión inicial

RESPONSABLE
Flavio Brocca

FECHA DEL CAMBIO

Tabla de Contenidos

Interfaz SID– REST Service


1
INTRODUCCIÓN 3

● OBJETIVOS 3

● DESTINATARIOS 3

1. INTERFAZ DATOS 4

2. DESARROLLO DE INTERFAZ 4
2.1 Generación de transacciones 4
2.2 Generar el token (JSON Web Token o JWT) 7
2.3 Alta de Cliente 8
2.4 Baja de Cliente
2.5 Clientes Registrados
2.6 Aviso de Fallecimiento

Interfaz SID– REST Service


2
INTRODUCCIÓN

OBJETIVOS

Este documento especifica la interfaz que consumirán los sistemas del cliente con la solución SID provista
por el RENAPER. Se especifican cada uno de los posibles mensajes y las respuestas.

DESTINATARIOS

El presente documento está destinado a las siguientes personas:

LECTOR SECTOR O ROL

Desarrolladores de integración Cliente

Interfaz SID– REST Service


3
1. Interfaz SID

La interfaz del sistema SID está basada en api REST.

URL: https://apirenaper.idear.gov.ar/apidatos

2. Desarrollo de Interfaz

A continuación, se detallan las operaciones expuestos al sistema cliente.


1. Generar el token (JSON Web Token o JWT)
2. Alta de Cliente.
3. Baja de Cliente.
4. Clientes Registrados.
5. Aviso de Fallecimiento clientes registrados.

2.1 Generación de transacciones

En este apartado se describen los parámetros que necesitan ser enviados y las respuestas esperadas por
cada operación. Dichas transacciones serán enviadas como operaciones HTTP POST o GET.

2.2 Generar token

Objetivo: generación de token* (JSON Web Token o JWT) , a través de un usuario y contraseña para luego
ser utilizado en el resto de la operaciones .
 el token es único
 el token vence a las 23:59:59 del día que fue generado

* TOKEN:JSON Web Token o JWT es un estándar abierto (RFC 7519) que define una forma compacta y autónoma para transmitir
información de forma segura entre las partes como un objeto JSON. Esta información se puede verificar y confiar porque está
firmada digitalmente.

Interfaz SID– REST Service


4
METODO: POST
URL: https://apirenaper.idear.gov.ar/
Recurso: CHUTROFINAL/API_ABIS/Autorizacion/token.php

Entrada:

NOMBRE DESCRIPCIÓN REQUERIDO ESQUEMA

username Nombre de usuario SI STRING


provisto por el RENAPER

password Password provista por el SI STRING


RENAPER

Salida:

NOMBRE DESCRIPCIÓN ESQUEMA

código_http Código HTTP (tabla1) STRING

mensaje_http Mensaje HTTP (tabla1) STRING

data DATA

DATA:
NOMBRE DESCRIPCIÓN ESQUEMA

Código Código respuesta interno (tabla2) STRING

mensaje Mensaje de respuesta interno STRING


(tabla2)

token Token generado STRING/NULL

TABLA 1:

HTTP_CODIGO HTTP_MENSAJE ESQUEMA

200 OK DATA

405 Method Not Allowed NULL

Interfaz SID– REST Service


5
TABLA 2: POSIBLES CÓDIGOS Y MENSAJES INTERNOS

CÓDIGO MENSAJE
0 TOKEN GENERADO

1 ERROR INTERNO

2 USUARIO NO REGISTRADO

3 ERROR EN LOS DATOS INGRESADOS

4 LIMITE DE PRUEBA EXCEDIDO/ LIMITE DE


TRANSACCIONES EXCEDIDO
6 CUENTA DE USUARIO SUSPENDIDA

Ejemplo 1 json de respuesta - USUARIO NO REGISTRADO

{
"codigo_http": 200,
"mensaje_http": "OK",
"data": {
"codigo": 2,
"mensaje": "USUARIO NO REGISTRADO",
"token": null
}
}

Ejemplo 2 json de respuesta - TOKEN GENERADO

{
"codigo_http": 200,
"mensaje_http": "OK",
"data": {
"codigo": 0,
"mensaje": "Token generado",
"token": "eyJ0eXAiOiJKV1QiLCJhb..."
}

Interfaz SID– REST Service


6
2.3 Alta de Cliente

Objeto: el método recibe DNI + SEXO y devuelve un conjunto de datos

URL: https://apirenaper.idear.gov.ar/
METODO: PUT
RECURSO: /CHUTROFINAL/apidatos/test/aviso_fallecimiento_alta_cliente.php
Header: Authorization: Bearer TOKEN_GENERADO

ENTRADA:

NOMBRE DESCRIPCION REQUERIDO ESQUEMA


dni Numero de documento SI INTERGER
nacional de identidad
sexo Sexo del titular del DNI SI STRING (F/M/X)

SALIDA:

NOMBRE DESCRIPCION ESQUEMA


codigo STRING
mensaje STRING
id_cliente STRING
fecha_alta STRING

TABLA: POSIBLES CÓDIGOS Y MENSAJES

CODIGO MENSAJE
401 Acceso Denegado / Acceso Denegado: Expired Token / Cuenta de Usuario
Suspendida
200 El cliente ya se encuentra registrado
201 Cliente creado
412 Campo dni es obligatorio / Campo sexo es obligatorio
500 Error Interno

Ejemplo 1 json de respuesta - ACCESO DENEGADO


{
"codigo": 401,
"mensaje": "ACCESO DENEGADO
}

Interfaz SID– REST Service


7
Ejemplo 2 json de respuesta - TRANSACCIÓN REALIZADA CORRECTAMENTE

{
"codigo": 201,
"mensaje": "CLIENTE CREADO",
"id_cliente": 729252,
"fecha_alta": "2022-11-29 10:45:54"
}

2.4 Baja de Cliente

Objeto: el método recibe DNI + SEXO y devuelve un conjunto de datos

URL: https://apirenaper.idear.gov.ar/
METODO: PUT
RECURSO: CHUTROFINAL/apidatos/test/aviso_fallecimiento_baja_cliente.php
Header: Authorization: Bearer TOKEN_GENERADO

ENTRADA:

NOMBRE DESCRIPCION REQUERIDO ESQUEMA


dni Numero de documento SI INTERGER
nacional de identidad
sexo Sexo del titular del DNI SI STRING (F/M/X)

SALIDA:

NOMBRE DESCRIPCION ESQUEMA


codigo STRING
mensaje STRING

TABLA: POSIBLES CÓDIGOS Y MENSAJES

CODIGO MENSAJE
401 Acceso Denegado / Acceso Denegado: Expired Token / Cuenta de Usuario
Suspendida
200 Cliente Eliminado
204 Cliente no registrado
412 Campo dni es obligatorio / Campo sexo es obligatorio
500 Error Interno

Interfaz SID– REST Service


8
Ejemplo 1 json de respuesta - ACCESO DENEGADO
{
"codigo": 401,
"mensaje": "ACCESO DENEGADO
}

Ejemplo 2 json de respuesta - TRANSACCIÓN REALIZADA CORRECTAMENTE

{
"codigo": 200,
"mensaje": "CLIENTE ELIMINADO"
}

2.5 Clientes Registrados

Objeto: devolución de la cantidad total de clientes registrados en el método de Alta.

URL: https://apirenaper.idear.gov.ar/
METODO: GET
RECURSO: CHUTROFINAL/apidatos/test/aviso_fallecimiento_clientes_registrados.php
Header: Authorization: Bearer TOKEN_GENERADO

SALIDA:

NOMBRE DESCRIPCION ESQUEMA


codigo STRING
mensaje STRING
clientes_registrados Total de clientes registrados STRING
ultimo_cliente_registrado Array con datos de transacción ARRAY

ULTIMO CLIENTE REGISTRADO:

NOMBRE DESCRIPCION ESQUEMA


id_cliente STRING
dni STRING

Interfaz SID– REST Service


9
sexo STRING
fecha_alta Año, mes, día, hora, minutos, STRING
segundos en que se dio de alta.

TABLA: POSIBLES CÓDIGOS Y MENSAJES

CODIGO MENSAJE
200 Ok
204 Sin Clientes Registrados
500 Error Interno

Ejemplo 1 json de respuesta - ACCESO DENEGADO


{
"codigo": 401,
"mensaje": "ACCESO DENEGADO
}

Ejemplo 2 json de respuesta - TRANSACCIÓN REALIZADA CORRECTAMENTE

{
"codigo": 200,
"mensaje": "OK",
"clientes_registrados": "1",
"ultimo_cliente_registrado": {
"id_cliente": "729258",
"dni": "537218",
"sexo": "F",
"fecha_alta": "2022-12-05 10:34:32"
}
}

2.6 Aviso de fallecimiento

Objeto: devolución del aviso de fallecimiento en la fecha de verificacion consultada.

URL: https://apirenaper.idear.gov.ar/
METODO: GET
RECURSO: CHUTROFINAL/apidatos/test/aviso_fallecimiento_por_cliente.php?fecha=2022-03-23
Header: Authorization: Bearer TOKEN_GENERADO
Interfaz SID– REST Service
10
ENTRADA:

NOMBRE DESCRIPCION REQUERIDO ESQUEMA


fecha fecha de verificacion del SI STRING
tramite

SALIDA:

NOMBRE DESCRIPCION ESQUEMA


codigo STRING
mensaje STRING
fecha fecha de verificacion consultada STRING
fallecidos Array con datos de transacción ARRAY

FALLECIDOS:

NOMBRE DESCRIPCION ESQUEMA


dni DNI del Fallecido STRING
sexo Sexo del Fallecido STRING
fecha_entrada Fecha en la que el RENAPER STRING
recibió el aviso por parte del
Registro Civil que lo informa.
hora_entrada Hora en la que el RENAPER recibió STRING
el aviso por parte del Registro Civil
que lo informa.
fecha_fallecimiento Fecha de fallecido STRING
provincia_ocurrencia Provincia donde ocurrió. STRING
tipo Estado o canal por el que fue STRING
recibido el fallecimiento:
1= Verificado
2= Observado
3= Presunto
4= CDHV

Interfaz SID– REST Service


11
TABLA: POSIBLES CÓDIGOS Y MENSAJES

CODIGO MENSAJE
200 Ok
412 Formato campo fecha no válido / Formato campo fallecimiento no válido.
Debe ser mayor o igual a 1900 y menor a ...."
500 Error Interno

Ejemplo 1 json de respuesta - ACCESO DENEGADO


{
"codigo": 401,
"mensaje": "ACCESO DENEGADO
}

Ejemplo 2 json de respuesta - TRANSACCIÓN REALIZADA CORRECTAMENTE

{
"codigo": 200,
"mensaje": "OK",
"fecha": "2022-12-05",
"cantidad_registros": 1,
"fallecidos": [
{
"dni": "4990690",
"sexo": "F",
"fecha_entrada": "2022-12-04",
"hora_entrada": "21:02:14",
"fecha_fallecimiento": "2022-12-03",
"provincia_ocurrencia": "CIUDAD DE BUENOS AIRES",
"tipo": 1
}
]
}

FALLECIMIENTOS PARA REALIZAR LA PRUEBA DE FLUJO COMPLETO:

DNI SEXO FECHA FALLECIMIENTO FECHA VERIFICACIÓN

30795642 F 2/3/2022 06/3/2022

13315617 F 10/3/2022 10/3/2022

8315541 M 10/3/2022 10/3/2022

11529521 F 10/3/2022 10/3/2022

Interfaz SID– REST Service


12
93447141 F 10/3/2022 10/3/2022

95119149 F 10/3/2022 10/3/2022

Interfaz SID– REST Service


13

También podría gustarte