Guía de Navegación

Guía de Navegación
Conoce el flujo de navegación del portal
Guía de Navegación del portal

En esta guía especificamos el flujo de navegación que se debe seguir en el portal, especificando sobre las acciones a realizar en cada paso con videos explicativos dentro de cada uno de ellos:

 

Registro en el portal

Explorar el Catálogo

Registrar Aplicación

Suscribirse a un Producto API

Integración en Producción

Probar API con Workspace (ej: Postman)

Registro

Haz clic en el botón "Acceder" situado en la esquina superior derecha y continúa pinchando "Registro".

Comencemos desde el botón acceder.

Rellena este sencillo formulario para que podamos dar de alta tu usuario. Antes de hacer clic en Registro, recuerda aceptar los Términos de uso.

Formulario para dar de alta tu usuario

A continuación recibirás un e-mail con un enlace al que debes acceder para validar tu cuenta.     
No podrás acceder a Api Market si no la validas previamente.

 

Entorno Sandbox

Entorno Sandbox
Comprueba lo fácil que es utilizar e integrar nuestros servicios.
Entorno Sandbox

Estás en el entorno Sandbox, donde encontrarás un contexto de prueba en el que gestionar y validar los Productos API que has encontrado en nuestro Catálogo.

Una vez registrado en el apartado "Acceder", podrás consultar el Producto API para el que te hayas dado de alta y probar sus funcionalidades, interfaces y flujos de entrada y salida de datos de dichas APIs, con las restricciones y limitaciones propias de un entorno de prueba.

En este entorno de prueba podrás validar los aspectos clave incluidos en el servicio real de los Productos API disponibles en el entorno de producción.

Junto con la documentación técnica de cada API, podrás encontrar un documento con la relación de casos de uso que se han definido en el catálogo sandbox para dicha API y para todas las que pertenezcan al mismo Producto. Existe una batería de casos de uso significativos para cada una de las operaciones disponibles. Éstos vendrán definidos con una descripción, los campos de entrada para probar el caso, además de los campos de salida que se obtienen como respuesta para cada uno de ellos. También podrás encontrar en ese documento los valores enumerados o tablas de códigos utilizados como campos de entrada o salida en todas las APIs de ese mismo Producto.

¿No encuentras lo que buscas? Ponte en contacto con nosotros, nuestro equipo estará encantado de ayudarte.

Si deseas acceder al Entorno de Producción para realizar las integraciones finales, puedes hacerlo a través del apartado ''Acceder al entorno de producción'' haciendo clic en el enlace al final de la descripción.

Registro

Ve a la página principal de API_Market y pincha sobre el botón de registro.

Sólo tienes que rellenar un breve formulario. No olvides indicar si eres un desarrollador particular o si representas una empresa.

 Tendrás que aceptar los términos de uso de API_Market. Cuando estés listo, dale al botón de registro y comprueba tu correo de entrada. Te enviaremos un enlace para que puedas validar tu cuenta. No podrás entrar en API_Market si no has validado tu cuenta.

 

ACCESO A JUEGO DE DATOS

Las APIs que encontrarás expuestas en el entorno Sandbox son completamente funcionales. Por la propia naturaleza de entorno de pruebas propio de Sandbox, el uso de estas APIs está limitado a un juego de datos concreto, con lo que podrás validar la integridad de los flujos de información entre los sistemas y con ella las funcionalidades de negocio habilitadas.

En los siguientes ficheros, encontrarás los correspondientes juegos de datos para probar las APIs, así como los campos y formatos de los datos información tanto de entrada como de salida:

Cómo usar las APIs

Cómo usar las APIs
Cómo usar las APIs
Cómo usar las APIs

Ten en cuenta que para poder comenzar a probar/usar las APIs debes estar registrado y haber iniciado sesión. A partir de ahí, estos son los pasos que debes seguir

Registrar una Aplicación en el portal:

Puedes registrar una Aplicación desde tu zona de usuario. Solamente es necesario proporcionar un nombre y una descripción. En cuanto lo hagas, anota las credenciales para esa Aplicación, que te serán asignadas nada más realizar el alta (client_id y client_secret). Éstas serán necesarias en los próximos pasos para poder utilizar la API de autorización y poder, posteriormente,  invocar a la API concreta que quieras probar. Además, puedes necesitar las credenciales de usuario del entorno (en sandbox se puede indicar cualquier valor). Es muy importante hacerlo en este momento puesto que el client_secret nunca más se presentará como texto plano.

 


1. Suscribir una Aplicación a los Productos que contengan las APIs que desees probar

Una vez creada la Aplicación, ésta deberá estar suscrita a los Productos que contengan las APIs que quieras probar/usar. Para eso, accede al Producto que desees probar dentro del Catálogo y pulsa en el botón Suscribirme

       
 

En ese momento, pasarás a la siguiente pantalla, donde se te permitirá indicar cuál de las Aplicaciones que tienes registradas es la que deseas suscribir a este Producto. 

 


2. Suscribir la misma Aplicación al Producto OAuth2-provider, que contiene la API que permite autorizar la aplicación con el portal

Además de suscribir la Aplicación a aquellos Productos que quieras probar, deberás, siguiendo los mismos pasos, suscribirla al producto OAuth2-provider, que contiene la API que te permitirá autorizar a tu Aplicación en este entorno sandbox. Así, todas las Aplicaciones que crees tendrán que estar suscritas a los productos que quieras probar/usar con dicha Aplicación y al Producto OAuth2-provider.        
Invocar a la API OAuth2-provider para conseguir el token de acceso        
La API OAuth2-provider del Producto con el mismo nombre tiene un par de operaciones para realizar la autorización de tu aplicación: una te proporcionará el token de acceso necesario para poder invocar a las APIs y otra te proporcionará un token de refresco que evitará que tengas que volver a enviar tus credenciales username y password cuando el primer token caduque.


Obtener el token de acceso        
Para obtener el token de acceso deberás invocar al endpoint POST /token de la API OAuth2-provider. Necesitarás enviar los siguientes campos:

grant_type: Se indicará el valor password         
client_id: Se debe proporcionar el client_id de la aplicación        
client_secret: Se debe proporcionar el client_secret de la aplicación        
username: Usuario del entorno (indicar un valor cualquiera para el entorno de sandbox)        
password: Contraseña del entorno (indicar un valor cualquiera para el entorno sandbox)        
scope: Indicar tantos scopes como sea necesario. Los posibles valores son: read, update, delete, create. Se pueden indicar varios al mismo tiempo, separándolos por espacios

Se obtendrá una respuesta como la siguiente:

{        
    "token_type": "Bearer",        
    "access_token": "Jksjwhwh. . . .",        
    "expires_in": 3600,        
    "consented_on": 1605085323,        
    "scope": "create read update delete",        
    "refresh_token": "AKJiogjd. . .",        
    "refresh_token_expires_in": 2592000        
}

La propiedad access_token es el token de acceso que deberemos utilizar en la cabecera Authorization para invocar a la API. Es un token de corta duración.

La propiedad refresh_token es un token que nos permitirá conseguir un nuevo token de acceso cuando el access_token haya caducado, puesto que el primero es de larga duración.


Refrescar el token        
A la hora de refrescar el token ya no es necesario enviar el usuario/contraseña (username y password) del entorno. Se envía la siguiente información:

grant_type: Se indicará el valor refresh_token        
client_id: Se debe proporcionar el client_id de la aplicación        
client_secret: Se debe proporcionar el client_secret de la aplicación        
refresh_token: Se debe indicar el valor de la propiedad refresh_token que devolvió la invocación con la que se solicitó el token de acceso

Se obtiene una respuesta similar a la de la solicitud del token, con la que tendrás un nuevo access_token y también un nuevo refresh_token para usar cuando necesites de nuevo refrescarlo el token de acceso.

En cualquier caso, puedes encontrar información más detallada en este portal, en la Documentación de esta API.        
Utilizando el token de acceso conseguido en el paso anterior, invocar a la API que quieras probar        
Una vez obtenido el token invocando a la API OAuth2-provider, éste debe ser incluido en cada una de las invocaciones a la API que hagas en la cabecera Authorization. Recuerda que es un token Bearer, por lo que tendrás que indicarlo precediendo al valor del token en esta cabecera. Si tu token de acceso es token123, la cabecera Authorization quedará:

Authorization: Bearer token123

El resto de campos de entrada dependerán ya de cada uno de los endpoints de las APIs y del caso concreto de uso que quieras probar. Recuerda que puedes consultar en el portal toda la información técnica necesaria para conocer los detalles de estos campos, los casos de uso e incluso ejemplos en diferentes lenguajes de programación. Lo tienes disponible en la sección Documentación de cada una de las APIs publicadas.        
 

Para integrar las APIs en tu ERP, puedes encontrar información relativa al proceso de dicha integración en las webs de los diferentes proveedores. A continuación listamos algunos de los más utilizados con sus referencias hacia la gestión de integraciones via APIs:

SAP API Manager

Microsoft Dynamics 365

Epicor

Geinfor

Netsuite

Sage

Catálogo de Productos

Catálogo de Productos
Te explicamos paso a paso cómo invocar e integrar un API en tu sistema.
Catálogo de Productos API

Consultando nuestro catálogo de Productos API para la gestión del crédito comercial de tu empresa, encontrarás toda la información sobre funcionalidades y documentación técnica de cada una de ellas. Si no encuentras lo que buscas, ponte en contacto con nosotros. ¡Estaremos encantados de asesorarte!

Los productos API que encontrarás en nuestro catálogo de productos, te permitirán una fácil integración de procesos en tus sistemas para gestionar tu crédito comercial de manera mucho más sencilla. Desde el catálogo de Productos API, podrás acceder a una detallada descripción funcional, de características y de requisitos de uso de cada API, así como los datos que ésta requerirá y la información correspondiente que te brindará.

Ante cualquier duda que te pueda surgir, puedes contactarnos sin problema en la pestaña de ''Contacto''.

Registro

Haz clic en el botón "Acceder" situado en la esquina superior derecha y continúa pinchando "Registro".

Comencemos desde el botón acceder.

Rellena este sencillo formulario para que podamos dar de alta tu usuario. Antes de hacer clic en Registro, recuerda aceptar los Términos de uso.

Formulario para dar de alta tu usuario

A continuación recibirás un e-mail con un enlace al que debes acceder para validar tu cuenta.    
No podrás acceder a Api Market si no la validas previamente.

 

Accede al entorno de producción

Accede al entorno de producción
Accede al entorno de producción

Para acceder a las funcionalidades completas del entorno de Producción, deberás solicitar el correspondiente registro a nuestro departamento de Atención al Cliente, el cual gestionará y habilitará tu registro de acuerdo a tu perfil de cliente.

Una vez registrado e iniciado sesión, en el entorno de producción podrás gestionar tus Productos API con la integridad de funcionalidades.

Este contexto, podrás registrar tus aplicaciones a las que integrar los Productos API a los que sindiques para integrarla en tus sistemas en toda su dimensión.

Productos API disponibles en entorno de producción:  OAuth2 Provider - CESCEFacil - Sales - Risk - Claims 

Acceso a Entorno de Producción