S I N S A C
  • Consultas
    • Integradas
    • Dinámicas
  • Reportes
    • INEGI
  • Documentación

    Documentación
  • Inteligencia de negocios
  • Almacén de datos
  • ETL
    • General

    • Visual Studio
    • SSIS
    • SQL Server Agent
  • API
    • General

    • Integradas
    • Dinámicas
  • Glosario
  1. Inicio
  2. Documentación
  3. API

API

¿Qué es un API?

Una API significa Interfaz de programación de aplicaciones (Application Programming Interface)

Las interfaces de programación de aplicaciones, o API, simplifican el desarrollo y la innovación de software al permitir que las aplicaciones intercambien datos y funciones de manera fácil y segura.

Esto permite que los servicios y productos se comuniquen entre sí y aprovechen los datos y la funcionalidad de los demás a través de una interfaz documentada. Los desarrolladores no necesitan saber cómo se implementa una API; simplemente usan la interfaz para comunicarse con otros productos y servicios.

¿Cómo funciona?

1. Una aplicación cliente inicia una llamada API para recuperar información, también conocida como solicitud. Esta solicitud se procesa desde una aplicación al servidor web a través del Identificador uniforme de recursos (URI) de la API e incluye un verbo de solicitud, encabezados y, a veces, un cuerpo de solicitud.

2. Después de recibir una solicitud válida, la API realiza una llamada al programa externo o servidor web.

3. El servidor envía una respuesta a la API con la información solicitada.

4. La API transfiere los datos a la aplicación solicitante inicial.

API de SINSAC

Los datos mostrados en esta aplicación son recuperados mediante API, SINSAC hace una solicitud al servidor, este devuelve un objeto JSON. Mediante JS, SINSAC procesa los datos recuperados y los muestra en gráficas y tablas al usuario.

VS Installer

Pruebas

Se puede utilizar una herramienta para realizar peticiones HTTP como POSTMAN o desde el mismo navegador utilizando solo la URI.

En el siguiente ejemplo se utiliza POSTMAN para la API de getMunicipios, el cual nos devuelve los municipios que hay en el Estado.

VS Installer

Si se utiliza el navegador, la respuesta se muestra de la siguiente manera.

VS Installer

Todas las peticiones son del tipo POST.

Para las consultas dinámicas es necesario utilizar la herramienta de POSTMAN.

SINSAC

Los objetos XMLHttpRequest (XHR) se utilizan para interactuar con los servidores. Puede recuperar datos de una URL sin tener que actualizar la página completa. Esto permite que una página web actualice solo una parte de una página sin interrumpir lo que está haciendo el usuario.

SINSAC realiza peticiones XHR en JS para recuperar datos del servidor y mostrar la información recuperada en tablas y graficas.

SINSAC realiza peticiones XHR para recuperar datos del servidor y mostrar la información recuperada en tablas y graficas.

Crea el objeto constructor

const req = new XMLHttpRequest();

Recibe respuesta del servidor y procesa la información

req.onload = function () { const json = JSON.parse(this.responseText); }

Abre la petición al servidor

req.open("GET", base_URI + "api/getTiposPrepiedad", true);

Envia petición

req.send();

Guía

En los siguientes apartados se muestra las URI disponibles para hacer uso de la API en SINSAC.

Inegradas Hacer peticiones a la API sin parámetros.
Dinámicas La URI de la API necesita en el cuerpo parámetros de búsqueda.
  • Instituto para el Registro del Territorio del Estado de Colima | Dirección de Catastro | Tecnológico Nacional de México Campus Colima

Última actualización del almacén de datos 2022-08-12 01:05:18.374205

SINSAC LOGO

Desarrollado con

Dirección de Catastro del Estado de Colima
  • Calzada Galván esquina con Aldama S/N, C.P. 28010, Colima, Colima, México

  • 312 31 39 290 / 312 31 31 814

GOB LOGO
  • © 2022
  • Política de privacidad
  • Acerca de