Soporte

Un plan desempeña las siguientes funciones:

• Controlar las API que puede usar un desarrollador de aplicaciones.
• Poner a disposición una colección de operaciones (HTTP GET, PUT, POST y DELETE) procedentes de una o más API.
• Aplicar límites de peticiones a las API para diferenciar las ofertas.
• Implementar distintos límites de velocidad (rate limit) para especificar cuántas peticiones se le permite realizar a una aplicación consumidora durante un determinado intervalo de tiempo definido.

Puede utilizar el portal de desarrolladores para explorar los diferentes planes que están disponibles para usted. Puede seleccionar el plan que mejor se adapte a sus necesidades. Muchas de las APIs tienen planes predeterminados disponibles para usar de inmediato y tenemos planes premiun. Estos planes tienen acceso restringido y tendrá que solicitar permiso para su uso. Cuando envíe su solicitud se le notificará a la organización, y se evaluará su solicitud.

Cada API puede tener límites de uso por minutos o segundos para evitar un uso excesivo. Puedes encontrar detalles específicos en la documentación de los planes de cada API. 

Ofrecemos dos tipos de planes: el Plan Default y el Plan Premium.

• Plan Default: Este plan permite un número limitado de peticiones a nuestras APIs. Es ideal para desarrolladores y pequeñas empresas que están comenzando. 
• Plan Premium: Este plan ofrece un mayor número de peticiones y está diseñado para empresas con necesidades más avanzadas. Requiere aprobación por parte del banco.

Si excedes el límite de peticiones en tu plan, las APIs responderán con un error indicando que has excedido el límite de peticiones

Antes de pasar al ambiente productivo, se requerirá una validación de su aplicación y sus casos de uso en el ambiente de Sandbox.

El Cliente debe realizar un Ticket a Soporte con la siguiente información:

• Caso de uso de la aplicación consumidora
• RNC
• Información de la empresa
• Nombre legal de la empresa
• Dirección registrada de la empresa
• Antecedentes de la empresa (naturaleza del negocio + productos)
• Información de contacto
  • Nombre, puesto, dirección de correo electrónico y número de contacto de la persona encargada de la aplicación
  • Nombre, puesto, dirección de correo electrónico y número de contacto de la persona de contacto técnico
• Lista de productos API que se utilizarán
• Fecha estimada de salida

Una vez que se envíen los detalles y se realice la evaluación, el Banco le enviará un acuerdo de licencia de API para su revisión y aprobación. Una vez completados los requisitos, el equipo API del Banco Popular Dominicano enviará lo siguiente: 

• Correo para la creación de ID y credenciales en producción 
• Correo con URL de producción

En este glosario, encontrarás definiciones y explicaciones claves para comprender mejor el mundo de las interfaces de programación de aplicaciones (APIs). Desde conceptos básicos hasta detalles avanzados, este glosario te ayudará a navegar por el fascinante universo de las APIs.

1. Portal del Desarrollador: El portal del desarrollador es una interfaz web donde los desarrolladores pueden descubrir, explorar y aprender sobre las API disponibles. Proporciona documentación, ejemplos, pruebas y acceso a claves de API.
2. Catálogo: Un destino de preparación (staging) que se comporta como una partición lógica de la puerta de enlace y el Portal del Desarrollador. Las URL para llamadas de API y para el Portal del Desarrollador son específicas de un catálogo particular.
3. Catálogo de API: Un catálogo es un destino de preparación (staging) que se comporta como una partición lógica de la puerta de enlace y el Portal del Desarrollador. 
4. ID de cliente: Información que identifica una aplicación individual. Una aplicación puede invocar una API solo si pasa una clave de aplicación reconocida por el sistema y se le otorga acceso a la API.
5. Secreto de cliente: Información utilizada junto con la clave de aplicación para verificar la identidad de una aplicación. Una API puede configurarse para requerir que las aplicaciones cliente suministren su secreto de cliente junto con su ID de cliente.
6. Operación de API: Llamada de API REST que consta de un verbo HTTP y una ruta de URL (punto final). Por ejemplo, GET /api/usuarios devuelve una lista de usuarios.
7. Documentación de API: La documentación de API proporciona detalles sobre cómo usar una API, incluidos ejemplos de solicitud y respuesta, parámetros, autenticación y más. Es esencial para que los desarrolladores comprendan y utilicen correctamente las API.
8. Autenticación de API: Los métodos de autenticación, como tokens de acceso, claves de API o certificados, garantizan que solo las aplicaciones autorizadas puedan acceder a una API.
9. Límite de tasa (Rate Limiting): Establece cuántas solicitudes de API un cliente puede realizar en un período de tiempo específico.
10. Producto de API: se refiere a un conjunto de APIs que ofrecen capacidades dentro de un mismo contexto funcional o una misma línea de negocio. Es la unidad mínima por la cual se puede consumir un API.
11. Endpoint: Es una ubicación digital donde una API recibe solicitudes relacionadas con un recurso específico en su servidor. En términos más sencillos, un endpoint permite especificar la “ubicación” de un recurso dentro de una API. Por lo general, se representa como una URL (Uniform Resource Locator) que indica dónde se encuentra ese recurso en el servidor. Cuando los clientes interactúan con una API, especifican un endpoint en sus solicitudes para acceder a los recursos deseados.
12. Rutas: Son fundamentales para dirigir las solicitudes entrantes a los recursos adecuados en el servidor. Son combinaciones de un método HTTP y una ruta de recurso. Las rutas son como señales de tráfico que guían las solicitudes hacia los recursos correctos dentro de tu API.
13. Códigos de estado de respuesta HTTP: indican si se ha completado satisfactoriamente una solicitud HTTP específica. Estas respuestas se agrupan en cinco clases: Respuestas Informativas (100–199), Respuestas Satisfactorias (200–299), Respuestas de Redirección (300–399), Respuestas de Error del Cliente (400–499), Respuestas de Error del Servidor (500–599).

Cuando ves una página con el mensaje "Acceso denegado", significa que no tienes permiso para acceder a ese recurso.

Esto puede deberse a varias razones:

• Permisos insuficientes: No tienes los permisos necesarios para ver la página o el archivo en cuestión.
• Restricciones de IP: La dirección IP desde la que estás accediendo está bloqueada o restringida.
• Autenticación requerida: La página requiere que inicies sesión o te autentiques antes de acceder.

Si crees que tu clave de API ha sido comprometida, desactívala inmediatamente desde la sección "Mis Aplicaciones" y genera una nueva clave. También, contacta a nuestro equipo de soporte para informar sobre el incidente.

Si encuentras algún problema o necesitas asistencia, puedes contactar a nuestro equipo de soporte a través del formulario de contacto en el portal de desarrolladores.

Nuestras API siguen las mejores prácticas de seguridad, incluyendo el uso de HTTPS para todas las comunicaciones, autenticación robusta y limitación de tasas de solicitud para prevenir abusos.

El ambiente de Sandbox es un entorno de prueba donde los clientes pueden validar su aplicación y sus casos de uso antes de pasar al ambiente productivo. Este ambiente maneja data ficticia, para pruebas. 

Para acceder al ambiente de Sandbox el cliente puede registrarse, proporcionando la información requerida.

Para hacer una solicitud, utiliza la URL base de la API junto con el endpoint específico que deseas acceder. Asegúrate de incluir tu clave de API en los encabezados de la solicitud. 

En el API Portal Popular, puedes acceder a la sección "Estadísticas" para ver informes detallados sobre el uso de las APIs, incluyendo el número de solicitudes, tiempos de respuesta y errores.

Es posible probar una API de este Portal del desarrollador.

Al consultar los detalles de una API, verá una lista de las operaciones contenidas en la API. Esto mostrará la operación 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, lo que devuelve, 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 especificarse utilizando las credenciales de aplicación en la parte superior de la sección 'Probar'.

Al añadir una aplicación, se le suministra una clave y un secreto de API para la aplicación. Debe proporcionar estas credenciales cuando llame a una API que requiera autenticar la aplicación.

Para registrar una aplicación, pulse Aplicaciones en el menú principal y luego pulse el enlace 'Crear aplicación'. Una vez que haya proporcionado un nombre de aplicación, descripción, etc., visualizará la clave y el secreto de API de la aplicación.

Anote su secreto de API, ya que sólo se visualiza una vez.

El secreto de API se almacena cifrado, de modo que no podemos recuperar la versión sin cifrada para indicarle el valor si lo ha olvidado.

Puede restablecerlo, con lo que actualizará el valor almacenado y le devolverá el valor nuevo.

Para ello, pulse 'Aplicaciones' en el menú principal, pulse en la aplicación en cuestión y luego puede pulsar el enlace 'Restablecer' en la sección 'Secreto de API'.

El nuevo secreto se mostrará en la parte superior de la página.