El portal de la API de Kubo centraliza la documentación técnica de la API, las credenciales de acceso y los endpoints disponibles para la integración.
A través del portal, es posible consultar la referencia de la API y probar los endpoints directamente en el entorno de pruebas interactivo.
Instrucciones
Solicitar acceso al portal de documentación de la API
El acceso a la documentación de la API está restringido a usuarios previamente registrados. Para solicitar acceso, sigue los pasos que se indican a continuación:
-
Abre una solicitud de asistencia técnica a Kubo
Una vez completado el registro, recibirás un correo electrónico con el asunto Bem-vindo ao Portal de APIs Kubo - Configure seu acesso, enviado por Portal APIs Kubo LXP. -
Abre el correo electrónico recibido y haz clic en el botón Ativar Minha Conta e Definir Senha
Por motivos de seguridad, el enlace de activación es válido durante 24 horas. Si el plazo caduca, será necesario solicitar al servicio de asistencia que te reenvíe la invitación. -
En la pantalla Ativar sua conta, introduzca una contraseña de acceso con un mínimo de 8 caracteres
-
Confirme la contraseña en el campo de abajo
-
Haga clic en el botón Salvar Senha e Acessar Portal
-
Introduzca su correo electrónico y su contraseña
-
Haga clic en el botón Acessar Portal
Acceder al portal de documentación de la API
Tras activar la cuenta, para acceder a la documentación de la API, siga los pasos que se indican a continuación:
-
Accede al portal de documentación de la API
-
Haz clic en el botón Acessar Portal en la esquina superior derecha
-
Introduce tu correo electrónico y tu contraseña
-
Haz clic en el botón Acessar Portal
Tras iniciar sesión, se mostrará la pantalla Visão Geral da API, con los endpoints disponibles.
También puedes navegar por el menú lateral izquierdo para acceder a un endpoint específico.
Realizar la autenticación
Antes de probar cualquier endpoint de la API, recomendamos realizar la autenticación:
-
En el menú lateral izquierdo, haz clic en AUTENTICAÇÃO
-
Haz clic en el endpoint POST Login (/v3/auth/login)
-
En el campo senha, introduce la contraseña de acceso al portal de documentación de la API
-
Haz clic en el botón Try it out
Cuando la autenticación se haya realizado con éxito, el portal mostrará el estado de la solicitud y el token devuelto.
Tras ejecutar con éxito el endpoint de inicio de sesión, el token se captura y se guarda en la sesión. De este modo, el resto de puntos finales disponibles en el menú lateral izquierdo se pueden probar con normalidad.
Para ello, accede al endpoint deseado, introduce los parámetros solicitados, si los hay, y haz clic en el botón Try it out para ejecutar la solicitud.
El resultado se mostrará en el área RESPONSE, que contiene el estado de la solicitud y los datos devueltos por la API.