Cómo utilizar nuestras API
¿Qué son los planes?
Un plan es una colección de recursos o subconjuntos de recursos de API de una o varias APIs. Un plan puede contener una combinación de tipos de operación de distintas APIs. Un plan puede tener un límite de velocidad común para todos los recursos, o cada recurso puede tener un límite de velocidad diferente. Los límites de velocidad especifican cuántas solicitudes puede efectuar una aplicación durante un intervalo de tiempo especificado.
Utilice este Portal del desarrollador para examinar los diversos planes que están disponibles y seleccione el plan más adecuado a sus necesidades. Algunos planes tienen acceso restringido, y debe solicitar acceso para utilizarlos. Cuando envíe su solicitud, se informará a la organización, el administrador de API evaluará su solicitud y puede que se ponga en contacto con usted para obtener más detalles. Otros planes están disponibles para su uso inmediato.
¿Cómo puedo ver mi consumo de APIs?
Los números de solicitudes de diferentes APIs que la aplicación ha efectuado se muestran en la página de aplicación.
Pulse 'Aplicaciones' en el menú principal y pulse en la aplicación. En la tabla 'Suscripciones del producto' verá todos los planes a los que está suscrita la aplicación.
Para cada API contenida en ese plan, puede ver el uso comparado con el límite de velocidad del plan.
¿Cómo puedo probar una API?
Al consultar los detalles de una API, verá una lista de las operaciones contenidas en la misma. Esto mostrará el verbo y la vía de acceso que se utilizará para la operación.
Si pulsa en la operación, verá más información sobre él, los parámetros que puede utilizar, la información que devuelve la API, los posibles códigos de retorno que podría utilizar y lo que significan.
También hay un botón 'Probar' en las API REST que permite probar la operación directamente desde el Portal del desarrollador.
Si la API requiere un ID de cliente o un secreto de cliente para la identificación, puede especificarlos utilizando las credenciales de aplicación en la parte superior de la sección 'Probar'.
¿Como solicito un token de autorización para OAUTH2?
En primer lugar, se requiere crear una aplicación en Developer Portal, la cual tendrá un nombre definido por el usuario y una URL de identificación de la aplicación del cliente [URL_SERVICIO].
Esta URL de identificación del servicio es requerida para el alta de la Aplicación y puede ser la URL propia de la aplicación que consumirá la API en caso de ser web o puede ser una URL que defina el cliente y que se corresponda con un dominio propio.
Como resultado de este proceso, se entregará un Client ID[CLIENT_ID] y Client Secret[CLIENT_SECRET].
Adicionalmente, en el apartado de seguridad de la API, se indica el Scope o Ámbitos[SCOPE], el Security Flow o Flujo de seguridad y la URL para obtener el token [TOKEN_URL].
Con esta información se podrá solicitar un token. A continuación, un ejemplo usando el comando curl (reemplazar las variables con los datos indicados anteriormente):
Solicitud:
flujo de seguridad clientCredentials:
curl --location --request POST '[TOKEN_URL]?scope=[SCOPE]' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'service: [URL_SERVICIO]' --data-urlencode 'client_id=[CLIENT_ID]' --data-urlencode 'client_secret=[CLIENT_SECRET]' --data-urlencode 'grant_type=client_credentials'
flujo de seguridad password:
curl --location --request POST '[TOKEN_URL]?scope=[SCOPE]' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'service: [URL_SERVICIO]' --data-urlencode 'client_id=[CLIENT_ID]' --data-urlencode 'username=[USUARIO]' --data-urlencode 'password=[PASSWORD]' --data-urlencode 'grant_type=password'
Respuesta:
En ambos casos la respuesta es la misma:
{
"access_token": "xxx", # El token a utilizar en el llamado de la API
"token_type": "bearer", # Tipo de token
"expires_in": 7200, # Tiempo de vida de un token en segundos
"refresh_token": "xxxx", # Token de refresh
"id_token": "xxxx" # Identificador del token
}
El valor a utilizar cuando se solicita el token es el indicado en el atributo
access_token
Este token deberá ser utilizado hasta la su expiración. El sistema que integre las APIs debe tener un proceso que resguarde este token, controle su vigencia y en caso de expiración vuelva a solicitar un nuevo token
¿Como crear un Operador APIs?
Para aquellas APIs que requieran un token OAuth2 con el flujo de seguridad password es necesario crear un Operador API en la plataforma Interbanking.
Creación del Operador APIs
Para crear este Operador API es necesario realizar los siguientes pasos:
Nota: Se requiere permisos de administrador dentro de la plataforma
Ingresar a la plataforma Interbanking
Ir al menú Administración -> Operadores
Al pie de la página, hacer clic en CREAR NUEVA
En la siguiente pantalla, indicar en Tipo de Operador:
Operador Apis.Los campos País emisor del documento y CUIL se indican como obligatorios pero, para este tipo de operador, no son necesarios por lo tanto dejar como está y hacer clic en SEGUIR.
Completar los datos requeridos para el operador. Luego hacer clic en SEGUIR.
Tomar nota de
Número de Clave de Sistemainformado por el sistema,UsuarioyClaveconfigurado por el usuario.En la siguiente pantalla validar que esté seleccionado el permiso de operador Transferencias. Hacer clic en SEGUIR.
Verificar y confirmar la operacion haciendo clic en GUARDAR
Si la empresa tiene administración conjunta, se requiere la autorización del alta para finalizar la creación de este nuevo operador.
Uso del Operador APIs
Finalizado este proceso, los datos obtenidos y configurados en el punto 5 se utilizan, en la opción [USUARIO] y [PASSWORD], para la generación del token OAuth2 del flujo de seguridad password (ver pregunta anterior).
Estos datos se utilizan de la siguiente forma:
Cuando se indique ingresar
[USUARIO]debe contener la siguiente información:-3|numero_clave_sistema|usuarioDonde:
- -3 y | son valores fijos
- numero_clave_sistema es el valor obtenido en el punto 5 ("Número de Clave de Sistema")
- usuario es el valor definido en el punto 5 ("Usuario")
Ejemplo:
-3|123456789|usuario1
- Cuando se indique ingresar
[PASSWORD]debe usar el valor definido en el punto 5 como “Clave”
Ejemplo:
Password#1234
¿Cual es la URL del servicio?
La URL del servicio se indica durante el proceso de creación de una aplicación en el API Portal en la opción “URL(s) de redirección de OAuth de aplicación”.
Esta URL es requerida ya que se necesita para solicitar el token de autorización.
Se recomienda ingresar una URL que contenta el nombre de la aplicación junto con el dominio de la empresa.
¿Donde obtengo el "customer-id"?
El customer-id es el código de abonado del cliente en Interbanking.
Ingresando a la aplicación web, ingresar al menú Administracion -> Bancos y cuentas. Luego buscar, en el apartado Información Adicional, Código Cliente Interno.