Localización e información de Sucursales y Cajeros
Rutas
/branches/rcoords
Este recurso proporciona información sobre las sucursales localizadas dentro del área de búsqueda definida.
Este recurso proporciona información sobre las sucursales localizadas dentro del área de búsqueda delimitada por dos puntos que forman un rectángulo.
Identify the application (client-id) to request the API
Nombre de la vista
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "branch.read". Posteriormente introduce el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar que aplicación (client-id) solicita el API.
Cabecera para identificar el content type utilizado en la petición.
Latitud de la coordenada que limita al noreste el área de búsqueda
Latitud de la coordenada que limita al suroeste el área de búsqueda
Longitud del punto que limita al noreste el área de búsqueda
Longitud del punto que limita al suroeste el área de búsqueda
Número máximo de resultados que queremos que nos proporcione el API. Si se omite mostrará todos.
Parámetro para filtrar por texto contenido en la respuesta
Parámetro que indica si se realiza una búsqueda global (true) o si por el contrario se toman los parámetros de búsqueda definidos en la vista indicada (false)
OK
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente.
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
/branches/ccoords
Este recurso proporciona información sobre las sucursales localizadas dentro del área de búsqueda definida.
Este recurso proporciona información sobre las sucursales localizadas dentro del área de búsqueda definida por un punto central y un radio, formando un círculo.
Identify the application (client-id) to request the API
Nombre de la vista
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "branch.read". Posteriormente introduce el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar que aplicación (client-id) solicita el API.
Cabecera para identificar el content type utilizado en la petición.
Latitud del punto que determina el centro del área de búsqueda
Longitud del punto que determina el centro del área de búsqueda
Número máximo de resultados que queremos que nos proporciones el API
Radio de búsqueda (en km) a partir del punto central definido
Parámetro para filtrar por texto contenido en la respuesta
Parámetro que indica si se realiza una búsqueda global (true) o si por el contrario se toman los parámetros de búsqueda definidos en la vista indicada (false)
OK
Sucede cuando el servidor no puede o no procesará la solicitud debido a un error aparente del cliente.
Sucede cuando se requiere autenticación y ha fallado o aún no se ha proporcionado.
Sucede cuando el usuario puede haber iniciado sesión pero no tiene los permisos necesarios para el recurso.
Sucede cuando la solicitud con los criterios especificados no existe en la base de datos.
Sucede cuando el servicio de negocios agotó el tiempo de espera para la respuesta.
Sucede cuando se encontró una condición inesperada y ningún mensaje más específico es adecuado.
Sucede cuando carece de la capacidad de satisfacer la solicitud. Esto implica la disponibilidad futura.
/view/{viewName}
Este API muestra la estructura de la vista seleccionada.
Este API muestra el filtrado que realizará la vista seleccionada.
Identify the application (client-id) to request the API
Nombre de la vista
Cabecera para identificar el dispositivo que solicita el API, por ejemplo: Navegador móvil, Tablet, Reloj, etc. Web Browser como predeterminado para Mac / PC.
Cabecera para Token de acceso, formato OAuth2. Para obtener el token se debe utilizar el API "SECURITY OAUTH" contenida en el producto "P-SECURITY", con parametro scope = "branch.read". Posteriormente introduce el token obtenido precedido de la palabra "Bearer" y un espacio.
Cabecera para identificar que aplicación (client-id) solicita el API.
Cabecera para identificar la sesión de la aplicación consumidora
Cabecera para identificar el content type utilizado en la petición.
Esta API responderá en el encabezado Content-Language el idioma utilizado en la respuesta.
OK
Happens when the server cannot or will not process the request due to an apparent client error
Happens when authentication is required and has failed or has not yet been provided
Happens when the user might be logged in but does not have the necessary permissions for the resource
Happens when the customer_id does not exist into the database
Happens when The Business Service timed out waiting for the response
Happens when an unexpected condition was encountered and no more specific message is suitable.
Happens when it lacks the ability to fulfill the request. This implies future availability
Definiciones
{
"properties": {
"code": {
"type": "string",
"example": "SomethingBadHappened"
},
"message": {
"type": "string",
"example": "Something bad happened :("
},
"level": {
"type": "string",
"example": "warning"
},
"description": {
"type": "string",
"description": "Verbose, plain language description of the problem with hints about how to fix it."
},
"moreInfo": {
"type": "string",
"example": "http:\/\/developer.ibm.com\/product\/errors\/1234"
}
},
"required": [
"code",
"message",
"level",
"description",
"moreInfo"
]
}
{
"properties": {
"defeault": {
"type": "string",
"example": "CAJERO AUTOMÁTICO"
}
},
"additionalProperties": false,
"required": [
"defeault"
]
}
{
"properties": {
"defeault": {
"type": "string",
"example": "CAJERO DISPENSADOR"
},
"es": {
"type": "string",
"example": "CAJERO DISPENSADOR"
}
},
"additionalProperties": false,
"required": [
"defeault",
"es"
]
}
{
"properties": {
"defeault": {
"type": "string",
"example": "SUCURSAL SANTADER SELECT"
}
},
"additionalProperties": false,
"required": [
"defeault"
]
}
Número de contacto.
{
"properties": {
"phoneNumber": {
"type": "string",
"description": "Número de contacto.",
"example": "91-5648693"
}
},
"additionalProperties": false,
"required": [
"phoneNumber"
]
}
{
"properties": {
"code": {
"type": "string",
"example": "IN_SERVICE"
}
},
"additionalProperties": false,
"required": [
"code"
]
}
{
"properties": {
"multi": {
"$ref": "#\/definitions\/comercialProduct"
},
"code": {
"type": "string",
"example": "ATM_INSIDE"
}
},
"additionalProperties": false,
"required": [
"multi",
"code"
]
}
{
"properties": {
"multi": {
"$ref": "#\/definitions\/multi"
}
},
"additionalProperties": false,
"required": [
"multi"
]
}
{
"properties": {
"multi": {
"$ref": "#\/definitions\/multi",
"example": "\"default\": \"EN SERVICIO\",\"es\": \"EN SERVICIO\""
},
"code": {
"type": "string",
"example": "IN_SERVICE"
}
},
"additionalProperties": false,
"required": [
"multi",
"code"
]
}
{
"properties": {
"type": {
"type": "string",
"example": "Point",
"description": "Tipo de localización de la sucursal."
},
"coordinates": {
"$ref": "#\/definitions\/coordinates",
"example": "[ -99.140273, 19.31204 ]",
"description": "Coordenadas de la sucursal."
},
"address": {
"type": "string",
"example": "Circuito Balvanera No. 22, Colonia Complejo Industrial Balvanera",
"description": "Dirección de la sucursal."
},
"zipcode": {
"type": "string",
"example": "76908",
"description": "Código zip de la sucursal."
},
"city": {
"type": "string",
"example": "Corregidora, Querétaro",
"description": "Ciudad de la sucursal."
},
"country": {
"type": "string",
"example": "MX",
"description": "País de la sucursal."
},
"locationDetails": {
"type": "string",
"example": "Coyoacán, Ciudad de México",
"description": "Detalles de la localización."
},
"parking": {
"type": "string",
"example": "SI",
"description": "Existencia de aparcamiento asociado a la sucursal."
},
"geoCoords": {
"$ref": "#\/definitions\/geoCoords",
"example": "",
"description": "Latitud y longitud de la sucursal."
},
"urlPhoto": {
"type": "string",
"example": "http:\/\/www.",
"description": "URL de la foto asociada a la sucursal."
},
"descriptionPhoto": {
"type": "string",
"example": "FRENTE",
"description": "Descripción de la foto asociada a la sucursal."
}
},
"additionalProperties": false,
"required": [
"coordinates",
"descriptionPhoto",
"geoCoords",
"type",
"address",
"zipcode",
"city",
"country",
"locationDetails",
"urlPhoto",
"parking"
]
}
Coordenadas de la sucursal.
{
"type": "array",
"items": {
"type": "number",
"format": "double"
}
}
Latitud y longitud de la sucursal.
{
"properties": {
"latitude": {
"type": "number",
"format": "double",
"description": "Geocoordenada latitud."
},
"longitude": {
"type": "number",
"format": "double",
"description": "Geocoordenada longitud."
}
},
"additionalProperties": false,
"required": [
"latitude",
"longitude"
]
}
Información sobre redes sociales
{
"properties": {
"youtubeLink": {
"type": "string",
"description": "Enlace a información en YouTube.",
"example": "http:\/\/www.youtube.com\/user\/bancosantander"
},
"facebookLink": {
"type": "string",
"example": "http:\/\/www.facebook.com\/bancoSantander",
"description": "Enlace a información en Facebook."
},
"twitterLink": {
"type": "string",
"example": "https:\/\/www.twitter.com\/santander_resp",
"description": "Enlace a información en Twitter."
},
"linkedinLink": {
"type": "string",
"example": "https:\/\/www.linkedin.com\/company\/santander-uk-corporate-&-commercial",
"description": "Enlace a información en Linkedin."
},
"instagramLink": {
"type": "string",
"example": "http:\/\/www.instagram.com\/bancosantander",
"description": "Enlace a información en Instagram."
},
"googleLink": {
"type": "string",
"example": "http:\/\/plus.google.com\/+bancosantander",
"description": "Enlace a información en Google."
}
},
"additionalProperties": true,
"required": [
"youtubeLink",
"facebookLink",
"twitterLink",
"linkedinLink",
"instagramLink",
"googleLink"
]
}
Información de citas.
{
"properties": {
"waitingTimeTeller": {
"type": "integer",
"example": "30",
"format": "int32",
"description": "Tiempo de espera en caja."
},
"waitingTimeSpecialist": {
"type": "integer",
"example": "30",
"format": "int32",
"description": "Tiempo de espera asesor."
},
"branchAppointment": {
"type": "string",
"example": "https:\/\/www.santander.co.uk\/uk\/book-an-appointment",
"description": "Cita previa."
}
},
"additionalProperties": false,
"required": [
"waitingTimeTeller",
"branchAppointment",
"waitingTimeSpecialist"
]
}
Horario.
{
"type": "array",
"items": {
"type": "string"
}
}
Hoario de los días laborables.
{
"properties": {
"WEDNESDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del domingo."
},
"MONDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del lunes."
},
"THURSDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del martes."
},
"SUNDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del miercoles."
},
"TUESDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del jueves."
},
"FRIDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del viernes."
},
"SATURDAY": {
"$ref": "#\/definitions\/scheduleDay",
"description": "Horarío del sábado."
}
},
"additionalProperties": false,
"required": [
"MONDAY",
"THURSDAY",
"SUNDAY",
"WEDNESDAY",
"TUESDAY",
"SATURDAY",
"FRIDAY"
]
}
Horario de servicio.
{
"properties": {
"workingDay": {
"$ref": "#\/definitions\/workingDay",
"example": "",
"description": "Días laborables."
},
"specialDay": {
"type": "array",
"items": {
"type": "string"
},
"description": "Días especiales."
}
},
"additionalProperties": false,
"required": [
"workingDay",
"specialDay"
]
}
Productos comerciales.
{
"type": "array",
"items": {
"$ref": "#\/definitions\/comercialProduct"
}
}
Lista de filtros por parte del servicio.
{
"type": "array",
"items": {
"$ref": "#\/definitions\/objectType"
}
}
Datos de los resultados encontrados.
{
"properties": {
"id": {
"type": "string",
"example": "594d1096cc5629c000f643be",
"description": "Identificador de la sucursal."
},
"code": {
"type": "string",
"example": "Santander_MEX_MX_X91459",
"description": "Código de la sucursal."
},
"entityCode": {
"type": "string",
"example": "Santander_MEX",
"description": "Código de la entidad bancaria."
},
"name": {
"type": "string",
"description": "Nombre de la sucursal.",
"example": "UVM COYOACAN"
},
"poiStatus": {
"type": "string",
"example": "ACTIVE",
"description": "Estado de la sucursal\/cajero automático."
},
"objectType": {
"$ref": "#\/definitions\/objectType",
"description": "Nombre de objeto presente en la sucursal."
},
"subType": {
"$ref": "#\/definitions\/subType",
"description": "Código de subtipo de objeto sucursal."
},
"specialType": {
"example": "",
"$ref": "#\/definitions\/specialType",
"description": "Tipo especial de sucursal\/cajero."
},
"description": {
"example": "",
"$ref": "#\/definitions\/description",
"description": "Descripción"
},
"status": {
"$ref": "#\/definitions\/status",
"description": "Estado y código de estado del objeto presente en la sucursal."
},
"location": {
"$ref": "#\/definitions\/location",
"description": "Datos de localización."
},
"distanceInKm": {
"type": "number",
"format": "double",
"example": 4.140251222336205,
"description": "Distancia en kilómetros."
},
"distanceInMiles": {
"type": "number",
"format": "double",
"example": 6.624401955737928,
"description": "Distancia en millas."
},
"contactData": {
"example": "",
"$ref": "#\/definitions\/contactData",
"description": "Información de contacto."
},
"socialData": {
"$ref": "#\/definitions\/socialData",
"description": "Información de las redes sociales."
},
"appointment": {
"$ref": "#\/definitions\/appointment",
"description": "Información de citas."
},
"schedule": {
"$ref": "#\/definitions\/schedule",
"description": "Horario de servicio."
},
"comercialProducts": {
"items": {
"type": "string"
},
"$ref": "#\/definitions\/comercialProducts",
"description": "Servicios financieros disponibles."
},
"spokenlanguages": {
"type": "string",
"example": "INGLES",
"description": "Información sobre diomas."
},
"attrib": {
"$ref": "#\/definitions\/attrib",
"example": "",
"description": "Filtros por parte del servicio."
},
"urlDetailPage": {
"type": "string",
"example": "https:\/\/locations.santander.com\/mx\/santander-mex\/mexico\/calzada-de-tlalpan-no-3058-colonia-santa-ursula-coapa\/",
"description": "URL de la página de detalle sobre la sucursal."
},
"dialogAttribute": {
"type": "string",
"example": "null",
"description": "Servicios no financieros"
},
"poicode": {
"type": "string",
"example": "X98512",
"description": "Identificador de sucursal."
}
},
"additionalProperties": false,
"required": [
"id",
"code",
"entityCode",
"name",
"poiStatus",
"objectType",
"subType",
"specialType",
"description",
"status",
"location",
"distanceInMiles",
"distanceInKm",
"contactData",
"socialData",
"appointment",
"schedule",
"comercialProducts",
"spokenlanguages",
"attrib",
"urlDetailPage",
"dialogAttribute"
]
}
Lista con los resultados encontrados
{
"type": "array",
"items": {
"$ref": "#\/definitions\/branch"
}
}
Respuesta a la llamada view
{
"properties": {
"id": {
"type": "string",
"description": "Identificador de la vista",
"example": "5730882bfdb4ba585f40742d"
},
"name": {
"type": "string",
"description": "Nombre de la vista",
"example": "mx"
},
"logo": {
"type": "string",
"description": "Nombre de la imagen asociada al logotipo",
"example": "santander.png"
},
"viewType": {
"description": "Tipo de vista",
"$ref": "#\/definitions\/viewType"
},
"coords": {
"description": "Coordenadas",
"$ref": "#\/definitions\/coordinates"
},
"initSearch": {
"description": "Búsqueda inicial",
"$ref": "#\/definitions\/initSearch"
},
"language": {
"description": "Idioma",
"$ref": "#\/definitions\/language"
},
"resultsConfig": {
"description": "Configuración de resultados",
"$ref": "#\/definitions\/resultsConfig"
},
"frontConfig": {
"description": "Configuración front",
"$ref": "#\/definitions\/frontConfig"
},
"literals": {
"description": "Literales",
"$ref": "#\/definitions\/literals"
},
"filters": {
"description": "Filtros",
"$ref": "#\/definitions\/filters"
}
},
"additionalProperties": false
}
Características activas en la vista
{
"properties": {
"title": {
"type": "boolean",
"description": "Título",
"example": "true"
},
"logo": {
"type": "boolean",
"description": "Logotipo",
"example": "true"
},
"footer": {
"type": "boolean",
"description": "Pie de página",
"example": "false"
},
"language": {
"type": "boolean",
"description": "Idioma",
"example": "false"
}
},
"additionalProperties": false
}
Objeto de búsqueda inicial
{
"properties": {
"text": {
"type": "string",
"description": "Texto",
"example": "Texto"
},
"attributes": {
"description": "Atributos",
"$ref": "#\/definitions\/attrib"
}
},
"additionalProperties": false
}
Búsqueda inicial
{
"properties": {
"es": {
"description": "busqueda inicial",
"$ref": "#\/definitions\/es"
}
},
"additionalProperties": false
}
Idioma
{
"properties": {
"defaultLanguage": {
"type": "string",
"description": "Idioma por defecto",
"example": "es"
},
"languageList": {
"type": "array",
"description": "Lista de idiomas disponibles",
"items": {
"type": "string"
},
"example": "[ \"es\" ]"
}
},
"additionalProperties": false
}
Configuración de parámetros
{
"properties": {
"maxResults": {
"type": "string",
"description": "Número máximo de resultdos",
"example": "250"
},
"numElemPag": {
"type": "string",
"description": "Número de elementos por página",
"example": "10"
},
"maxRadius": {
"type": "string",
"description": "Radio máximo de búsqueda",
"example": "100"
},
"minRadius": {
"type": "string",
"description": "Radio mínimo de búsquda",
"example": "0.5"
}
},
"additionalProperties": false
}
Detalles activos
{
"properties": {
"showCalltoAction": {
"type": "boolean",
"description": "Mostrar llamada a la acción",
"example": "false"
},
"showBanner": {
"type": "boolean",
"description": "Mostrar banner",
"example": "false"
},
"showProducts": {
"type": "boolean",
"description": "Mostrar productos",
"example": "true"
},
"showLanguages": {
"type": "boolean",
"description": "Mostrar idiomas",
"example": "false"
}
},
"additionalProperties": false
}
Configuración front
{
"properties": {
"maxLengthAddress": {
"type": "integer",
"description": "Máxima longitud de dirección",
"format": "int32",
"example": "0"
},
"maxResultsAttrib": {
"type": "integer",
"description": "Máximo número de atributos en los resultados",
"format": "int32",
"example": "3"
},
"maxResultsAddress": {
"type": "string",
"description": "Máximo número de direcciones en los resultados",
"example": "3"
},
"showDetails": {
"description": "Detalles mostrados",
"$ref": "#\/definitions\/showDetails"
}
},
"additionalProperties": false
}
Literales
{
"properties": {
"DETAILBRANCHTYPEDEFAULT": {
"type": "string",
"example": "Sucursal Santander",
"description": "Detalle tipo sucursal por defecto"
},
"DETAILBRANCHTYPESELECT": {
"type": "string",
"description": "Detalle tipo sucursal select",
"example": "Sucursal Santander Select"
},
"DETAILSCHEDULEHEADER": {
"type": "string",
"description": "Detalle de cabecera de horarios",
"example": "Horario de la sucursal"
},
"FILTERBRANCH": {
"type": "string",
"description": "Filtro de sucusal",
"example": "Sucursal"
},
"FILTERGROUP_BRANCHSERVICES": {
"type": "string",
"description": "Filtro de servicios de sucursal",
"example": "Servicios Sucursal"
},
"FILTEROPENSATS": {
"type": "string",
"description": "Filtro de apertura sábados",
"example": "Abierto sábados"
},
"FILTERSELECT": {
"type": "string",
"description": "Filtro sucursales select",
"example": "Sucursal Select"
},
"TITLE": {
"type": "string",
"description": "Título",
"example": "Buscador de Sucursales y Cajeros"
}
},
"additionalProperties": false
}
Literales
{
"properties": {
"es": {
"description": "Literales",
"$ref": "#\/definitions\/literalsObject"
}
},
"additionalProperties": false
}
Características de sucursales y cajeros
{
"properties": {
"BRANCH": {
"description": "Sucursal",
"$ref": "#\/definitions\/visibleActiveObject"
},
"EMBASSY": {
"description": "Embassy",
"$ref": "#\/definitions\/visibleActiveObject"
},
"ATM": {
"description": "Cajero",
"$ref": "#\/definitions\/visibleActiveObject"
},
"SELECT": {
"description": "Select",
"$ref": "#\/definitions\/visibleActiveObject"
}
},
"additionalProperties": false
}
Visibilidad y Actividad
{
"properties": {
"visible": {
"type": "boolean",
"description": "Indica si se encuentra visible",
"example": "true"
},
"active": {
"type": "boolean",
"description": "Indica si se encuentra activo",
"example": "false"
}
},
"additionalProperties": false
}
Características de sucursales y cajeros
{
"properties": {
"OPEN_SATURDAY": {
"description": "Abierto sábados",
"$ref": "#\/definitions\/visibleActiveObject"
},
"ACCESIBILITY": {
"description": "Accesibilidad",
"$ref": "#\/definitions\/visibleActiveObject"
},
"APPOINTMENT": {
"description": "Cita previa",
"$ref": "#\/definitions\/visibleActiveObject"
},
"PARKING": {
"description": "Aparcamiento",
"$ref": "#\/definitions\/visibleActiveObject"
},
"WIFI": {
"description": "Wifi",
"$ref": "#\/definitions\/visibleActiveObject"
}
},
"additionalProperties": false
}
Filtros aplicados
{
"properties": {
"tipoPOI": {
"description": "Tipo de sucursal y cajero",
"$ref": "#\/definitions\/tipoPOI"
},
"featurePOI": {
"description": "Características sucursal y cajero",
"$ref": "#\/definitions\/featurePOI"
},
"idiomasPOI": {
"type": "string",
"description": "Idiomas sucursal y cajero"
}
},
"additionalProperties": false
}