Guía rápida de como iniciar el API

Status API tiene como funcionalidad proporcionar el estatus de las distintas plataformas e integraciones que actualmente están registradas. Para detallar mas como se obtiene el estatus, el porcentaje de disponibilidad dado un periodo tiempo, por favor seguir a Parámetros y respuestas esperadas.

Para poder iniciar el Status Api en Local es necesario:

• Para el Status API clonar el repositorio en local, y trasladarse a la rama sobre la cual se quieren hacer pruebas. https://estratec.visualstudio.com/MasivMonitorPlatforms/_git/StatusApi
• Obtener una imagen de postgresql.

version: '3'
services:
  postgres:
    image: 'postgres:latest'
    environment:
      POSTGRES_USER: guest
      POSTGRES_PASSWORD: guest
      POSTGRES_DB: monitor_platform_db
    ports:
      - '5432:5432'

• Clonar repositorio https://estratec.visualstudio.com/MasivMonitorPlatforms/_git/Scripts, realizar las respectivas configuraciones sobre los parámetros de cada script para que estos puedan realizar toda la creación y poblado en la base de datos ejecutadas en la imagen de docker local.
• Obtener y registrar credenciales de la cuenta de Aws en local.
• Ya esta listo para ser ejecutados en maquina Local.

Autenticación

El endpoint del status api maneja dos diferentes autenticaciones :

• Autenticación genérica :
  • Labs: Auth =&LTW9uaXRvckxhYnNUb2tlbjprZXZwZjlxRTBPRG5IRmVI==
  • Prod: Auth =&PTW9uaXRvckxhYnNUb2tlbjp0WnpESFBNZ09MRU8wM0Na==
• Autenticación por Bearer Token para identificar MasivUser.
  • Labs - Prod : Auth = Bearer “Insertar Bearer Token Masiv User”

Códigos de respuesta

Parámetros y respuestas esperadas

El status Api tiene expuestos tres endpoints principales. El endpoint de obtención disponibilidad por un periodo de tiempo, tiene como finalidad retornar el porcentaje de disponibilidad de cada servicio en el rango y utc indicado. El endpoint de obtención de notificaciones, dado un rango de tiempo este obtiene las notificaciones por servicio. Por ultimo, el endpoint de realizar la petición al healthcheck de un servicio, en este se indica el servicio al que se quiere realizar la petición y retorna si esta disponible o no según la respuesta del healthcheck correspondiente al servicio.

Para cada endpoint se requiere las autorizaciones mencionadas. También, dependiendo de la autorización que se envié, así mismo se retornara los servicios correspondientes a cada cuenta.

Para revisar documentación mas detallada sobre cada endpoint se adjunta documentación de swagger.

https://api-monitor.masivapp.com/api/status/index.html

Versiones de la API