Guía de inicio APIs

Crea una cuenta en API Hub

¿Cómo crear una cuenta de desarrollador en API Hub?

Crear una cuenta es muy fácil y no tiene costo. Da clic en el botón "Iniciar Sesión" y después en la liga "Regístrate". Ingresa nombre completo, nombre de usuario y dirección de correo electrónico. Revisa la bandeja de entrada de tu cuenta de correo, ya que API Hub te enviará una liga de activación. Haz clic en la liga y completa tu perfil. ¡Listo! Ya puedes utilizar nuestras APIs de simulación.

¿Cómo registro mi aplicación en API Hub?

¿Cómo registro mi aplicación en API Hub?

Una vez que hayas creado y activado tu cuenta de desarrollador estarás listo para registrar tu aplicación y seleccionar las APIs que utilizará. Da clic en el menú "Mis aplicaciones" y después en el botón "+Crea una aplicación". Ingresa el nombre y una pequeña descripción acerca de tu aplicativo. En la sección "Productos *" selecciona las APIs que te interesa utilizar. Recuerda que utilizar las APIs de simulación (Sandbox) es el primer paso para desarrollar un prototipo con nosotros.

¿Cómo utilizo las APIs de simulación (Sandbox)?

¿Cómo utilizo las APIs de simulación (Sandbox)?

Después de registrar tu aplicación y las APIs que utilizará, es momento de realizar una petición de prueba. Para obtener el identificador, da clic en el menú "Mis aplicaciones" y después selecciona la aplicación que registraste. En la sección "keys" copia el valor del campo "Consumer Key" Para enviar una petición de prueba da clic en el menú "APIs", selecciona la API de simulación de tu interés dando clic en "Ver más". Después da clic en la liga "Ve a nuestro laboratorio". Ahora verás todos los métodos asociados al API. Puedes descargar el descriptor del API en formato Swagger o la colección de Postman para enviar peticiones desde tu computadora. También puedes usar el portal API Hub como cliente para enviar peticiones al simulador: solo da clic en el método que quieres probar. Pega el "Customer Key" como valor para el parámetro "x-api-key".

Copia el ejemplo de petición y pégalo en el cuadro de texto "Request Body" y da clic en "Enviar la petición". Podrás ver los datos de respuesta en la pestaña "Response".

Genera un par de llaves y carga la llave pública en el portal API Hub

¿Cómo genero el par de llaves?

API Hub recomienda utilizar OpenSSl https://www.openssl.org para la generación de tu par de llaves. Empieza generando la llave privada: $ openssl ecparam -name secp384r1 -genkey -out pri_key.pem La llave privada se genera en el archivo pri_key.pem ¡Nunca compartas esta llave y siempre mantenla con privilegios de acceso adecuados y en un lugar seguro! Después genera tu certificado: $ openssl req -new -x509 -days 356 -key pri_key.pem -out certificate.pem -subj "/C=MX/ST=CDMX/L=MH/O=CDC/CN=CDC" El archivo certificate.pem contiene tu llave pública. Para carga el certificado en el portal API Hub, da clic en el menú "Mis aplicaciones", después selecciona la aplicación que registraste, ve a la sección "Certificados para…". En el apartado "Tu certificado" selecciona el archivo certificade.pem y da clic en "Cargar". El portal API Hub te confirmará que tu certificado se ha guardado exitosamente.

¿Cómo descargo el certificado creado por API Hub?

¿Cómo descargo el certificado creado por API Hub?

Ahora que has subido tu certificado, será necesario descarga el certificado que API Hub ha generado para identificar a tu aplicación. Para descargar el certificado, da clic en el menú "Mis Aplicaciones", después selecciona la aplicación que registraste, ve a la sección "Certificados para …" En el apartado "Descarga tu certificado único para …" Da clic en "Descargar". Cada petición (payload) hacia una API de Círculo de Crédito deberá ser firmada electrónicamente con tu llave privada y la firma de la petición debe ser anexada como una cabecera HTTP (x-signature). Cada respuesta (payload) que provenga de una API de Círculo de Crédito deberá ser verificada con el certificado (llave pública) que API Hub ha generado para ti. Puedes encontrar la firma de la respuesta en la cabecera HTTP (x-signature).

¿Cómo pruebo la comunicación que API Hub?

¿Cómo pruebo la comunicación que API Hub?

Solicita el acceso la API Security Test V1, enviando un email a api@circulodecredito.com.mx con la siguiente información, por ej.

Asunto: Acceso API Security Test V1
Email registrado en API Hub: api@circulodecredito.com.mx
Nombre de la aplicación: Círculo de Crédito

Puedes probar la comunicación hacia API Hub a través del API Security Test. Da clic en el menú "APIs", selecciona la API "Security Test" y da clic en "Ver más". Selecciona el lenguaje de programación con el que quieras probar la comunicación. Descarga el código del cliente de GitHub y sigue las instrucciones que se encuentran en el archivo README.md. Recuerda siempre adjuntar el "Customer Key" como valor para el parámetro "x-api-key". La API Security Test te responderá con el mismo mensaje que has enviado en la petición. Todos los clientes del API Security Test verifican que la firma electrónica en la cabecera corresponda al payload y provenga de Círculo de Crédito.

¿Cómo puedo solicitar el acceso para utilizar APIs productivas?

¿Cómo puedo solicitar el acceso para utilizar APIs productivas?

¿Estás listo para utilizar nuestras APIs productivas?

Entra a la certificación a producción aquí.

¿Cómo sé que mi aplicación ya tiene acceso al ambiente productivo?

¿Cómo sé que mi aplicación ya tiene acceso al ambiente productivo?

El equipo de API Hub te enviará un correo de confirmación cuando tus accesos estén listos Puedes verificar los accesos dando clic en el menú "Mis aplicaciones"; después, selecciona la aplicación que registraste; en la sección productos tendrás nueva APIs asociadas. La API SecurityTest la utilizarás para probar la conexión segura. Identificarás las APIs productivas por su nombre, ya que carecen de la etiqueta "Sandbox".

¿Existen clientes en diferentes lenguajes de programación para consumir las APIs?

¿Existen clientes en diferentes lenguajes de programación para consumir las APIs?

Todas las APIs de Círculo de Crédito exponen su descriptor (Swagger) y un conjunto de colecciones en Postman que proveen la casuística del API. Tenemos diferentes clientes programados en varios lenguajes para facilitar el consumo de nuestras APIs. Los clientes firman las peticiones y verifican la firma de las respuestas de forma automática. Si no encuentras el cliente en tu lenguaje favorito, envíanos un correo a api@circulodecredito.com.mx y atenderemos la solicitud.