Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Web Services para Ingresar Clientes al Sistema.
Note |
---|
NO DEBE OLVIDAR Antes de consumir este Web Service, debe consultar cada una de los WS descritos en Web Services de Consulta de Categorías Generales, dado a que en ellos se listan los valores ya cargados de un conjunto de parámetros necesarios para ingresar un cliente al sistema, y dichos parámetros deben coincidir con los ya existentes en el para evitar errores y/o inconsistencias durante el ingreso de clientes, igualmente se debe respetar las constantes ya definida en el sistema, indicadas en la pagina de Constantes asociadas a variables preestablecidas en la Aplicación SIFCO WEB. . |
Swagger open api macro |
---|
swagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Ingresar clientes en la **Aplicación SIFCO WEB** ." termsOfService: "https://sifco.org/sobre-nosotros/" contact: email: "soporte@sifco.org" license: name: "Apache 2.0" url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "WSIngresarClientes" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/9ISo" produces: - application/json paths: /WSIngresarClientes: post: tags: - WSIngresarClientes operationId: "WSIngresarClientes" summary: "Ingresar Clientes al Sistema" parameters: - in: header name: Content-Type type: "string" required: true default: application/json - in: header name: Authorization type: "string" required: true default: OAuth <Access Token> - in: header name: GENEXUS-AGENT type: "string" required: true default: SmartDevice Application - name: "WSIngresarClientesInput" in: "body" required: false schema: $ref: "#/definitions/WSIngresarClientesInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSIngresarClientesOutput" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Not found" schema: $ref: "#/definitions/GxJsonError" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 500: description: "Internal server error" schema: $ref: "#/definitions/GxJsonError" security: - OAuth2: [] ApiKeyAuth1: [] securityDefinitions: OAuth2: type: oauth2 flow: password tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: Execute: Permite el método tipo GET Insert: Permite el método tipo POST Update: Permite el método tipo PUT Delete: Permite el método tipo DELETE FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1: type: apiKey in: header name: granttype definitions: WSIngresarClientesInput: properties: Modo: type: "string" ConsultaFormaIdentificar: type: "integer" format: "int32" ConsultaValorIdentificador: type: "string" WSCliente: description: WSInformacion Cliente $ref: "#/definitions/WSInformacionCliente" WSInformacionCliente: properties: CodigoCliente: description: Código del Cliente type: "integer" format: "int64" TipoDePersona: description: Tipo de Persona type: "string" TipoIdentificacion: description: Tipo de Identificación type: "integer" format: "int32" DocumentoIdentificacionPais: description: País de Emisión Documento type: "integer" format: "int64" DocumentoIdentificacionDepartamento: description: Código Región Emisión Identificación type: "integer" format: "int64" DocumentoIdentificacionMunicipio: description: Departamento Emisión Identificación type: "integer" format: "int64" DocumentoIdentificacionZona: description: Código Municipio Emisión Identificación type: "integer" format: "int64" NumeroIdentificacion: description: Número de Identificación Clientes type: "string" PrimerNombre: description: Primer Nombre type: "string" SegundoNombre: description: Segundo Nombre type: "string" PrimeApellido: description: Primer Apellido type: "string" SegundoApellido: description: Segundo Apellido type: "string" ApellidoCasada: description: Apellido de Casada type: "string" Sexo: description: Sexo Cliente type: "string" FechaNacimiento: description: Fecha de Nacimiento type: "string" format: "date" EstadoCivil: description: Estado Civil type: "integer" format: "int32" NombreJuridico: description: Nombre de Empresa o Sociedad type: "string" RepresentanteLegal: description: Nombre del Representante Legal type: "string" NumeroRegistroMercantil: description: Número de Registro Mercantil type: "string" FechaConstitucion: description: Fecha de Constitución type: "string" format: "date" Grupo: description: Código del Grupo de Afinidad type: "integer" format: "int64" NumeroIdentificacionTributaria: description: Número de Identificación Tributaria type: "string" Promotor: description: Código Promotor type: "string" AfectoAImpuestos: description: Afecto a Impuestos type: "string" EstadoCliente: description: Estado del Cliente type: "string" CodigoReferencia: description: Referencia type: "string" ActividadEconomica: description: Código de actividad económica type: "integer" format: "int32" DireccionEMailPrincipal: description: Correo Electrónico type: "string" DireccionEMailSecundario: description: Correo Electrónico Alternativo type: "string" ExcluirDeMensajesDeCorreo: description: Excluir de Correos Electrónicos type: "integer" format: "int32" ParametrosExtendidos_B1Integration: description: Parámetros Extendidos_B1 Integration $ref: "#/definitions/ParametrosExtendidos_B1Integration" Prestamos: type: array items: description: Préstamo $ref: "#/definitions/WSInformacionCliente.Prestamos" CuentasAhorro: type: array items: description: CuentaAhorro $ref: "#/definitions/WSInformacionCliente.CuentasAhorro" CalificadoresAdicionales: type: array items: description: CalificadorAdicional $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales" CuentasBancarias: type: array items: description: CuentaBancaria $ref: "#/definitions/WSInformacionCliente.CuentasBancarias" Telefonos: type: array items: description: Teléfono $ref: "#/definitions/WSInformacionCliente.Telefonos" Direcciones: type: array items: description: Dirección $ref: "#/definitions/WSInformacionCliente.Direcciones" ParametrosExtendidos_B1Integration: properties: CentrosDeCosto: type: array items: description: CentroDeCosto $ref: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto" Proyectos: type: array items: description: Proyecto $ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos" Transacciones: type: array items: description: Transacciones $ref: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones" Series: type: array items: description: Serie $ref: "#/definitions/ParametrosExtendidos_B1Integration.Series" ParametrosExtendidos_B1Integration.CentrosDeCosto: properties: Secuencia: description: Secuencia type: "integer" format: "int32" CodigoCCSAP: description: Código CCSAP type: "string" NombreCCSAP: description: Nombre CCSAP type: "string" CodigoCCSifco: description: Código CCSifco type: "integer" format: "int32" NombreCCSifco: description: Nombre CCSifco type: "string" x-gx-level: "ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Proyectos: properties: Secuencia: description: Secuencia type: "integer" format: "int32" CodigoProyectoSAP: description: Código Proyecto SAP type: "string" NombreCCSAP: description: Nombre CCSAP type: "string" CodigoCCSifco: description: Código CCSifco type: "integer" format: "int32" NombreCCSifco: description: Nombre CCSifco type: "string" x-gx-level: "ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Transacciones: properties: InterfazarCodigosDeTransaccion: description: Interfazar Códigos De Transacción type: "boolean" NombreCampoSAP: description: Nombre Campo SAP type: "string" x-gx-level: "ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Series: properties: ObjetoDeNegocio: description: Objeto De Negocio type: "integer" format: "int32" CodigoSerieSAP: description: Código Serie SAP type: "string" NombreSerieSAP: description: Nombre Serie SAP type: "string" x-gx-level: "ParametrosExtendidos_B1Integration" WSInformacionCliente.Prestamos: properties: NumeroPrestamo: description: Número del Préstamo type: "string" NombrePrestamo: description: Nombre del Préstamo type: "string" Producto: description: Codigo Producto type: "integer" format: "int32" SubProducto: description: Código SubProducto Colocación type: "integer" format: "int32" Saldo: description: Saldo de Capital type: "number" format: "double" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasAhorro: properties: NumeroCuenta: description: Numero Cuenta type: "string" Producto: description: Código Producto type: "integer" format: "int32" SubProducto: description: Código del SubProducto type: "integer" format: "int32" TieneCondicionesEspeciales: description: Tiene Condiciones Especiales type: "string" FrecuenciaCondicionesEspeciales: description: Código de la Frecuencia type: "integer" format: "int32" MontoDescuentoPlanilla: description: Monto Descuento Planilla type: "number" format: "double" FrecuenciaDescuentoPlanilla: description: Código de la Frecuencia type: "integer" format: "int32" Referencia: description: Cuenta de Referencia type: "string" Monto: description: Monto type: "number" format: "double" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CalificadoresAdicionales: properties: CodigoCalificador: description: Código type: "integer" format: "int32" ValorCalificador: description: Valor del calificador adicional type: "string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasBancarias: properties: Correlativo: description: Referencia Bancaria type: "integer" format: "int32" CodigoBanco: description: Código Banco type: "integer" format: "int32" TipoCuenta: description: Tipo de Cuenta type: "integer" format: "int32" NumeroCuenta: description: Número de la Cuenta type: "string" EstadoReferencia: description: Estatus de la Referencia Bancaria type: "string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.Telefonos: properties: Correlativo: description: Correlativo por cliente type: "integer" format: "int32" TipoTelefono: description: Tipo de teléfono type: "integer" format: "int32" NumeroTelefono: description: Número telefónico type: "string" ObservacionTelefono: description: Observaciones type: "string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.Direcciones: properties: Correlativo: description: Correlativo de Dirección type: "integer" format: "int32" TipoDireccion: description: Tipo de Dirección type: "integer" format: "int32" DireccionPais: description: Código país dirección type: "integer" format: "int64" DireccionDepartamento: description: Código Región Dirección type: "integer" format: "int64" DireccionMunicipio: description: Código Departamento Dirección type: "integer" format: "int64" DireccionZona: description: Código Municipio Dirección type: "integer" format: "int64" Direccion: description: Dirección type: "string" CodigoPostal: description: Código Postal type: "string" Geolocalizacion: description: Geolocalización type: "string" DireccionEmpresaDondeLabora: description: Nombre de la empresa donde labora type: "string" Puesto: description: Puesto en la empresa type: "string" x-gx-level: "WSInformacionCliente" WSIngresarClientesOutput: properties: CodigoCliente: type: "integer" format: "int64" ConsultaResultados: description: WSInformacion Cliente type: array items: $ref: "#/definitions/WSInformacionCliente" Messages: description: Messages type: array items: $ref: "#/definitions/Messages_Message" Result: type: "string" Messages_Message: properties: Id: description: Id type: "string" Type: description: Type type: "integer" format: "int32" Description: description: Description type: "string" GxJsonError: properties: error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Código de Error type: "string" message: description: Mensaje de Error type: "string" x-gx-level: "GxJsonError" |
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.
A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.
METODO POST
Este método permite la consulta o creación de datos en la Aplicación WEB, para este Web Service en especifico permite la Creación de Clientes en la Aplicación SIFCO WEB.
El siguiente ejemplo inserta un cliente en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
BODY:
| ||||||||||||
200 (Operación Exitosa) |
| ||||||||||||
400 (Requisicion Errada). 401 (No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ). 404 (Web Service, no encontrado). 500 (Error Interno del Servidor de las API’s REST). |
|
Note |
---|
NO DEBE OLVIDAR NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución. |
Note |
---|
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo. |
Code Block |
---|
Content-Type: application/json Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77... GENEXUS-AGENT: SmartDevice Application |
Warning |
---|
EN CASO DE ERROR HTTP 401 (Not Authenticated) Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST. |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Enlaces Relevantes | ||||||||||||
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|