Cómo comenzar a utilizar nuestro Sandbox

El sandbox es el espacio diseñado para que nuestros usuarios tengan un primer acercamiento con la integración de nuestras APIsAPIs - Es el proceso formal que permite a un usuario interactuar con otro sistema.. Está hecho para ser el lugar en el que las pruebas, los errores y las preguntas se puedan hacer sin ninguna repercusión real, ni de alteración de sistemas ni de costos.

Si ya estás en nuestro sandbox es porque ya tienes una cuenta. Con ella podrás acceder a realizar pruebas y cambiar a las etapas de Preproducción o Producción Si aún no has creado una cuenta, puedes hacerlo en https://prometeoapi.com/accounts/create/

Una vez validada, tendrás acceso completo al dashboard de la plataforma, donde podrás llevar el control del estado de tu cuenta.

En la segunda subsección de este dashboard encontrarás el API keyAPI key - Es la clave de autenticación única del cliente que deberá utilizar en todas las solicitudes de información (API Calls) al servicio PrometeoAPI. que te permitirá acceder y conectarte con las APIsAPIs - Es el proceso formal que permite a un usuario interactuar con otro sistema. de Prometeo. Será como tu identificación para poder hacer todos los procesos o conexiones que necesites. Es importante que la copies para poder utilizarla en los espacios donde se te solicite.

Ya teniendo tu API keyAPI key - Es la clave de autenticación única del cliente que deberá utilizar en todas las solicitudes de información (API Calls) al servicio PrometeoAPI. copiada, ingresa en el botón “ir a la documentación”.

Al ingresar a la documentación, en el panel izquierdo, encontrarás los tipos de API a los que puedes conectarte para empezar a hacer pruebas.

REFERENCIA DE LA API
En la parte superior de la documentación encontrarás “Referencia de la API” (Indicado con 1 en la imagen), allí podrás iniciar con el login.

En “Header” (indicado con 2 en la imagen) será el espacio donde debes pegar la API keyAPI key - Es la clave de autenticación única del cliente que deberá utilizar en todas las solicitudes de información (API Calls) al servicio PrometeoAPI. que copiaste anteriormente.
Para realizar pruebas en el Sandbox es muy importante que en “Base URL” (Indicado con 3 en la imagen) despliegues las opciones y verifiques que tienes seleccionada la opción de Sandbox, como se ve a continuación:

Una vez seleccionada la URL, vas al botón rojo “Try it” y en la parte inferior aparecerá la session Key que te será requerida en el momento de ir a los EndpointEndpoint - Es el punto de intercambio de información en la API.

Para seleccionar los EndpointEndpoint - Es el punto de intercambio de información en la API solo debes ir a la barra lateral en el botón “Datos transaccionales” y elegir el que necesites.

Al elegir el EndpointEndpoint - Es el punto de intercambio de información en la API debes ingresar la API keyAPI key - Es la clave de autenticación única del cliente que deberá utilizar en todas las solicitudes de información (API Calls) al servicio PrometeoAPI. y la Session Key que ya copiaste anteriormente; la primera en el espacio “X-API-key”, y la segunda en “Key”:

Ten en cuenta que esta clave caduca cada 5 minutos, por lo que si tu prueba de llamadas toma más tiempo, es necesario que repitas este proceso para obtener una nueva. La función de esta Session Key es evitar que debas estar iniciando sesión cada vez que quieras acceder a un endpoint diferente.

Recuerda que todos los cambios que realices en los espacios del formulario del panel central se reflejarán en el playground de la parte derecha de la pantalla.

Si aparece algún error, en la parte inferior del panel central encontrarás los posibles errores y lo que significan para que puedas resolverlos y continuar.

Si en algún momento necesitas ayuda o tienes alguna duda que no la resuelve la documentación, puedes comunicarte con nuestro equipo de soporte técnico en [email protected]


Did this page help you?