Guía rápida de como iniciar el API

Administrator API tiene como funcionalidad proporcionar la mayor parte de CRUDS sobre las traducciones, integraciones y notificaciones las cuales son indispensables en el flujo de obtención de resultados de disponibilidad desde la herramienta que contiene las métricas hasta el api que las procesa. También tiene como funcionalidad el registro de notificaciones las cuales también apoyan al registro de incidentes en el momento que se pueda presentar una indisponibilidad, y por ultimo registrar integraciones hacia los clientes, estos servicios son adicionales a los servicios básicos o internos que ya son registrados como traducciones.

Para poder iniciar el Administrator Api en Local es necesario:

• Para el Administrator API clonar el repositorio en local, y trasladarse a la rama sobre la cual se quieren hacer pruebas. https://estratec.visualstudio.com/MasivMonitorPlatforms/_git/AdministratorApi
• 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 administrator 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 Administrator Api tiene expuestos varios endpoints donde la mayor parte son CRUDS sobre las traducciones, integraciones y notificaciones dentro de las principales estan, el registro de notificaciones las cuales también apoyan al registro de incidentes en el momento que se pueda presentar una indisponibilidad, registrar integraciones hacia los clientes, estos servicios son adicionales a los servicios básicos o internos que ya son registrados como traducciones. Tambien contiene endpoints de Actualizaciones y obtención de datos sobre cada uno.

Para mas detalle sobre los endpoints, firmas y demás. A continuación se encontrara la documentación de swagger.

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