El portal para desarrolladores permite probar los métodos de lectura (GET) en el mismo portal: elige la aplicación con la que se identifica, ejecuta la solicitud, ve la respuesta real del gateway y copia la URL o un fragmento de código para integrarlo en su aplicación. En este video ve el recorrido completo, desde el catálogo hasta la misma llamada hecha con curl.
auth_key) o las credenciales OAuth 2.0.Ingrese a una API en el catálogo de la página de inicio del portal y seleccione un método en la lista Métodos. La ficha muestra su descripción, la ruta, el protocolo, cómo autenticar la solicitud, los límites y una respuesta de ejemplo.
Haga clic en Pruebe este método. En ¿Con qué aplicación te autenticarás? seleccione la aplicación que utilizará para la consulta: su llave de acceso se agrega a la URL de la solicitud. Si el método tiene parámetros, modifique sus valores si lo desea, y luego haga clic en Ejecutar. En Respuesta ve el código de estado y el contenido devuelto por el gateway, con un botón para copiarlo.
Desde la misma ventana puede copiar la URL completa de la consulta. Debajo de la ficha, Fragmentos de código muestra la llamada lista para pegar en distintos lenguajes y Especificación OpenAPI permite descargar la definición del método o de toda la versión.
La llave de acceso de su aplicación se envía como parámetro auth_key en la URL o como cabecera Authorization, según lo configure el administrador de la API. Por ejemplo:
curl "https://api.example.com/demo-ventas/v1/ventas.json?auth_key=YOUR_AUTH_KEY"
El botón ¿Cómo obtener una llave de acceso? de la ficha explica dónde encontrarla en Mis aplicaciones.
Si la API está protegida con OAuth 2.0, primero debe obtener un token de acceso con el client_id y el client_secret de su aplicación, y enviarlo en la cabecera Authorization: Bearer. La ventana de prueba ofrece Obtener token de acceso para hacerlo desde el portal. Vea Autenticación de APIs con API Keys y OAuth 2.0.
La ventana de prueba muestra el código 200 y la respuesta del método en el formato elegido. La misma URL, con su llave de acceso, responde igual desde cualquier cliente HTTP.