diff --git a/apigee/tecnologia.mensajes.json b/apigee/tecnologia.mensajes.json new file mode 100644 index 0000000..046584c --- /dev/null +++ b/apigee/tecnologia.mensajes.json @@ -0,0 +1,188 @@ +{ + "openapi": "3.0.0", + "servers": [ + { + "description": "Calidad", + "url": "https://colsubsidio-test.apigee.net/api" + }, + { + "description": "Producción", + "url": "https://colsubsidio-prod.apigee.net/api" + } + ], + "info": { + "description": "Información de los servicios de lo tecnologia para el manejo de mensajes.", + "version": "2.0.0", + "title": "Tecnologia mensajes", + "termsOfService": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger", + "contact": { + "email": "operacionesti@colsubsidio.com" + }, + "license": { + "name": "Colsubsidio", + "url": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger" + } + }, + "tags": [ + { + "name": "masiv-tecnologia-notificaciones", + "description": "Envío de mensajes de texto y correo" + } + ], + "paths": { + "/v2/tecnologia/notificaciones/sms": { + "post": { + "tags": [ + "masiv-tecnologia-notificaciones" + ], + "summary": "Envío de mensajes de texto", + "description": "Enviar mensaje de texto a un teléfono celular específico.", + "operationId": "notificacionesPorSMS.v2", + "requestBody": { + "$ref": "#/components/requestBodies/enviarMensajeSMSRequestBody" + }, + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/envioMensajeSMSResponse" + } + } + } + }, + "400": { + "description": "Error en la solicitud" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + } + }, + "externalDocs": { + "description": "Encontrar más información en EnterpriseArchitect", + "url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect" + }, + "components": { + "schemas": { + "resultado": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Código del resultado" + }, + "descripcion": { + "type": "string", + "description": "Descripción del resultado" + } + }, + "xml": { + "name": "resultado" + } + }, + "enviarMensajeSMSRequest": { + "type": "object", + "properties": { + "destino": { + "type": "string", + "description": "Número de celular al que va dirigido el mensaje" + }, + "contenido": { + "type": "string", + "description": "Texto a enviar en el mensaje, no debe superar los 140 caracteres." + } + }, + "xml": { + "name": "enviarMensaje" + } + }, + "envioMensajeSMSResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "envioSMS": { + "type": "object", + "properties": { + "idMensaje": { + "type": "integer", + "description": "Identificador del mensaje de respuesta" + }, + "destino": { + "type": "string", + "description": "Número de celular donde se envió el mensaje." + }, + "contenido": { + "type": "string", + "description": "Mensjae de texto enviado" + } + }, + "xml": { + "name": "resultado" + } + } + } + }, + "envioSMS": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "envioSMS": { + "type": "array", + "items": { + "$ref": "#/components/schemas/envioSMS" + } + } + } + } + }, + "requestBodies": { + "enviarMensajeSMSRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/enviarMensajeSMSRequest" + } + } + }, + "description": "Request para la creacion de un afiliado dependiente.", + "required": true + } + }, + "securitySchemes": { + "apigee_auth": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "https://colsubsidio-test.apigee.net/oauth/client_credential/accesstoken?grant_type=client_credentials", + "scopes": { + "write:apigee": "Permisos de escritura", + "read:apigee": "Permisos de lectura" + } + } + } + } + } + } +} \ No newline at end of file