Referencia API

Documentación de la API de MEDISMART 3.0.

Descripción General

Esta sección explica cómo autenticarse en el sistema MEDISMART 3.0 mediante OAuth2 para acceder a las APIs disponibles.

URLs Base

Las URLs base de la API son específicas para cada entorno:

• Entorno QA: https://qa-serv.medibuslive.com
• Entorno de Producción: https://serv.medibuslive.com

Autenticación

Todas las solicitudes a la API requieren autenticación. Primero debe obtener un token de acceso utilizando el flujo de credenciales de cliente OAuth2, luego incluir el token en los encabezados de las solicitudes subsiguientes.

Obtener Token de Acceso

Este endpoint se utiliza para autenticarse y obtener un token de acceso que será requerido para todas las demás rutas de la API.

Endpoint: POST /backoffice/api/client/oauth2/token

URL Base: Utilice la URL base apropiada según su entorno (QA o Producción)

Content-Type: application/x-www-form-urlencoded

Parámetros de Solicitud:

• grant_type (requerido): Debe ser client_credentials
• client_id (requerido): Su ID de cliente (proporcionado a cada cliente de forma anónima)
• client_secret (requerido): Su secreto de cliente (proporcionado a cada cliente de forma anónima)

Ejemplo de Solicitud:

curl --location 'https://qa-serv.medibuslive.com/backoffice/api/client/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=5353df94-0926-46cb-a249-5f8c1285cb7d' \
--data-urlencode 'client_secret=F-pqAh4DYgBwrCNjIu0QZgQpGJqUxjD11uEQWuq5HDo'

Nota: Las credenciales client_id y client_secret son proporcionadas a cada cliente de forma anónima. Contacte a su administrador para obtener estas credenciales.

Uso del Token de Acceso

Una vez que haya obtenido un token de acceso, inclúyalo en el encabezado Authorization de todas las solicitudes subsiguientes a la API:

Authorization: Bearer SU_TOKEN_DE_ACCESO

Endpoints de Cliente

Obtener Datos del Tenant

Este endpoint permite obtener la información del tenant (cliente), incluyendo el logo de la compañía, los planes creados y la URL del tenant.

Endpoint: GET /backoffice/api/client

URL Base: Utilice la URL base apropiada según su entorno (QA o Producción)

Autenticación: Requiere token de acceso en el encabezado Authorization

Ejemplo de Solicitud:

curl --location 'https://qa-serv.medibuslive.com/backoffice/api/client' \
--header 'Authorization: Bearer SU_TOKEN_DE_ACCESO'

Respuesta Exitosa (200 OK):

{
    "success": true,
    "message": "Tenant data retrieved successfully",
    "data": {
        "company_logo": "https://example.s3.us-east-1.amazonaws.com/custom-files/abc123def456/company-logo-1234567890123",
        "plans": [
            {
                "id": "507f1f77bcf86cd799439011",
                "name": "Plan Básico",
                "state": true
            },
            {
                "id": "507f191e810c19729de860ea",
                "name": "Plan Premium",
                "state": true
            }
        ],
        "url": "ejemplo.medismart.live"
    }
}

Campos de Respuesta:

• success (boolean): Indica si la solicitud fue exitosa
• message (string): Mensaje descriptivo de la operación
• data (object): Datos del tenant
  • company_logo (string): URL del logo de la compañía
  • plans (array): Lista de planes creados para el cliente
    • id (string): ID del plan (utilizado para cargar usuarios a un plan)
    • name (string): Nombre del plan
    • state (boolean): Estado del plan (activo/inactivo)
  • url (string): URL del tenant

Notas Importantes:

• Los id de los planes obtenidos en esta respuesta son los que se utilizan posteriormente para cargar usuarios a un plan específico