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 click 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 click 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 click 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 click 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 click en el menú "APIs", selecciona el API de simulación de tu interés dando click en "Ver más". Después da click 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. Tambien puedes usar el portal API Hub como cliente para enviar peticiones al simulador: solo da click 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 click en "Enviar la petición". Podrás ver los datos de respuesta en la pestaña "Response".

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

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

¿Estas listo para utilizar nuestras APIs productivas? Envíanos un correo a api@circulodecredito.com.mx con el tíulo "Solicitud de acceso a producción" y tu teléfono. Un representante de API Hub se pondrá en contacto contigo.

¿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 click en el menú "Mis aplicaciones"; después, selecciona la aplicación que registraste; en la sección productos tendrás nueva APIs asociadas. El 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".

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 generá 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 click 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 click 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 click 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 click en "Descargar". Cada petición (payload) hacia un 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 un 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?

Puedes probar la comunicación hacia API Hub a través del API Security Test. Da click en el menú "APIs", selecciona el API "Security Test" y da click 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". El 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 cabera corresponda al payload y provenga de Círculo de Crédito.

¿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.