API Market

Proceso para operar Open Banking de BanCoppel

Guía de operación

Paso 1: Registrarse en el servicio de sandbox


El registro lo podemos realizar en: https://www.bancoppelapimarket.com/ en el apartado: REGÍSTRATE

Recibirás un correo de: sso-circular@bancoppel.com, con el título: "Verificar correo electrónico", revisa en la bandeja de no deseados.

El mail contiene un link para activar la cuenta al sitio de Open Banking de BanCoppel.

 

Paso 2: Ingresa con tu usuario y contraseña del registro


Ingresa tus datos al portal en https://www.bancoppelapimarket.com/, en el apartado Entrar


Paso 3: Generar una aplicación


Debemos generar una nueva aplicación.


Se mostarran dos opciones:

  1. - BSI-ATMNetworkOperations-sandbox
  2. - BSI-ATMNetworkOperations-produccion


Para comenzar selecciona la opción de Sandbox (BSI-ATMNetworkOperations-sandbox). En caso de crear un API en el ambiente productivo se iniciará un proceso para obtener la autorización del uso del API en este ambiente, para esto debes esperar a que te contactemos.


Se deberá llenar la información de las APIS de BanCoppel


  1. Ingresamos el nombre
  2. La descripción de la aplicación, para reconocer de que se trata la herramienta
  3. Pulsamos: Crear aplicación

 

Paso 4: Datos para usar la API


Una vez que generamos la aplicación, el portal de BanCoppel nos dará los datos para conectarnos a la API de ATMS
Nos informa el tipo de ambiente: Sandbox

Cliente ID: XXXXX :: Este es el ID de cliente que debe enviar con cada solicitud de API.

Llave secreta del cliente: XXXXXXXXXXXXXXXXXXX :: Esta es la llave secreta del cliente utilizado para autenticar las solicitudes.

NOTA: Debemos guardar en un lugar seguro esta información, es la que nos permite accesar la información de Open Banking.

Redireccionar URL: Esta es su URL de redireccionamiento para OAuth

 

Paso 5: Obtener autorización de BanCoppel


Existen diversas maneras de probar las APIS, se ofrece el ejemplo con un comando CURL base, para facilitar la conectividad en algún lenguaje de programación especifico


cUrl
Método: POST
URL: https://sso-circular-slcu-rmngmnt-pop-prod.ocp1.bancoppel.com/auth/realms/DeveloperPortal/protocol/openid-connect/token


Autorización:


Type: Basic Auth
UserName: ClientID, el valor que obtuvimos cuándo registramos la aplicación
Password: Client_Secret El valor de la Llave secreta del cliente, que se tiene durante el registro de la aplicación
Al ejecutar el comando, se obtiene un token de acceso, para mandar llamar los datos de ATM


Paso 5: Obtener los datos de ATM de BanCoppel


Ejecutamos un comando: CURL
Método: POST
URL: https://apicast-circular-api-sdbox-apps.ocp1.bancoppel.com/ATMNetworkOperations/v1.0.0/atms
Proceso de autorización:
Type: Oauth 2.0
Token: Se manda el token bearer obtenido en la petición de acceso
Extracto de respuesta:


{
	"meta": {
		"LastUpdated": "2022-04-13T18:12:59.564Z",
		"TotalResults": 0,
		"Agreement": "To be confirmed",
		"License": "To be confirmed",
		"TermsOfUse": "To be confirmed"
	},
		"data": [
		{
			"Brand": [
				{
					"BrandName": "MÉXICO",
					"ATM": [
					{
						"Identification": "999994090",
						"SupportedLanguages": [
						""
						],
						"ATMServices": [

						""
						],
						"Accessibility": [
						""
						],
						"Access24HoursIndicator": true,
						"SupportedCurrencies": [
						""
						],
						"MinimumPossibleAmount": "5",
						"Note": [
						"string"
						],
						"OtherAccessibility": [
						{
							"Code": "stri",
							"Description": "string",
							"Name": "string"
						}
						],
						"OtherATMServices": [
						{
							"Code": "stri",
							"Description": "string",
							"Name": "string"
						}
						],
						"Branch": {
							"Identification": "N/A"
						},
						"Location": {
							"LocationCategory": [
							""
							],
							"OtherLocationCategory": [
								{
									"Code": "stri",
									"Description": "string",
									"Name": "TELEFONOS DE MEXICO SAB DE CV SAN JERONIMO"
								}
							],
							"Site": {
								"Identification": "string",
								"Name": "string"
							},
							"PostalAddress": {
								"AddressLine": "SAN JERONIMO LIDICE",
								"BuildingNumber": "9",
								"StreetName": "PINOS",
								"TownName": "MAGDALENA CONTRERAS",
								"CountrySubDivision": [
									"CD MEXICO"
								],