Pitchfork:la aplicación web API de la nube de Rackspace

Si desea una forma interactiva de hacer referencia a la documentación y ejecutar comandos de API para los productos de Rackspace Cloud, necesita interactuar con un producto rápidamente o desea aprovechar nuevos productos o funciones que no están disponibles en el Panel de control, Pitchfork podría ser la herramienta para tú.

Pitchfork es una aplicación API web interactiva que permite al usuario interactuar rápidamente con los productos de Rackspace Cloud. No es necesario abrir un símbolo del sistema o buscar cómo enviar objetos de datos mediante un comando cURL. La aplicación maneja todo esto por usted y muestra los resultados y las respuestas de las solicitudes de la API del producto que realizó en su cuenta de Cloud.

Pitchfork fue diseñado para realizar las llamadas API y mostrarle lo que necesita para las llamadas API para que pueda realizarlas utilizando otras herramientas o métodos. Puede usar la función simulada para verificar la estructura de datos de una llamada, que puede servir como una herramienta de referencia en sus programas API de Rackspace.

Las API pueden resultar confusas para los principiantes. Debido a que Pitchfork establece la estructura de llamadas por ti, puedes aprender mucho más rápido. A veces, la API es la única forma de realizar un cambio de configuración en un balanceador de carga o una base de datos en la nube, por ejemplo, y Pitchfork puede mostrarle cómo realizar la llamada y ejecutarla por usted.

Dónde encontrar Pitchfork

Puedes acceder a Pitchfork en la siguiente dirección:https://pitchfork.rax.io

Mira el código en GitHub.

Requisitos de inicio de sesión

No tiene que iniciar sesión en la aplicación para simular o navegar por cualquiera de las llamadas API. Debe iniciar sesión solo si desea ejecutar esas llamadas contra su cuenta.

Para iniciar sesión, haga clic en Iniciar sesión e ingrese sus credenciales de autenticación.

Autenticación

Pitchfork usa las mismas credenciales que usted usa en una solicitud de autenticación de API a Rackspace Cloud. Usted proporciona su nombre de usuario y clave API, y el sistema realiza la solicitud de autenticación por usted a través de HTTPS. Si la solicitud tiene éxito, la aplicación almacena el token y el catálogo de servicios que se devuelve y caduca la sesión junto con el token cuando sea el momento.

Utilice Pitchfork para enviar una llamada API

Una vez que haya iniciado sesión, utilice los siguientes pasos para enviar una llamada a la API mediante Pitchfork:

1. Navegue hasta cualquiera de los productos y busque la llamada que desea ejecutar.
2. Elija la región con la que desea interactuar.
3. Haga clic en Detalles .
4. Si hay alguna variable para la llamada, ingrésela.
5. Haga clic en Enviar llamada API .

La aplicación te muestra la siguiente información:

• URL de solicitud: La URL completamente construida a la que envió la llamada.

• Encabezados de solicitud: La parte de los encabezados de la solicitud que envió a la API.

• Solicitar objeto de datos: Si hay un objeto de datos que se creó para la llamada, se muestra con los valores que especificó.

• Encabezados de respuesta: Los encabezados recibidos en la respuesta de la API.

• Cuerpo de respuesta: Los datos de respuesta del servidor API. Esta respuesta podría incluir un código de estado, un objeto devuelto o un mensaje de error.

• Nota: Los encabezados de respuesta y el cuerpo de la respuesta se muestran solo para llamadas ejecutadas y no para llamadas simuladas. Debido a que los simulacros no se ejecutan, no hay respuesta para mostrar.

simulacros

La opción simulada le permite crear una llamada sin ejecutarla para que pueda ver cómo está estructurada la llamada. Haga clic en Llamada de API simulada cuando desee ver todos los detalles de la solicitud de una llamada. El objeto de datos de solicitud, si lo hay, se muestra con todas las opciones disponibles para la llamada y, como referencia, puede ver cómo está estructurado el objeto.

Advertencias para la ejecución de llamadas

Cuando inicia sesión, las llamadas se ejecutan en su cuenta de la nube. Hay notas en las llamadas para advertirle cuando está haciendo algo que afectará la facturación, así que tenga cuidado al ejecutar las llamadas.

Cuando simula una llamada, no se ejecuta ninguna llamada API, por lo que no hay impacto en su cuenta.

Historial de llamadas

Puede ver fácilmente el historial de llamadas que ha realizado haciendo clic en Historial en el menú. El historial muestra las llamadas que ha realizado junto con todos los detalles. El historial se guarda para las llamadas que ha ejecutado contra la API, independientemente de la respuesta. Las llamadas API simuladas no se registran en su historial. Debe iniciar sesión para ver su historial.

El historial de llamadas se guarda para permitirle auditar o hacer referencia a llamadas anteriores realizadas dentro del sistema. Esto es útil cuando varios usuarios utilizan el mismo conjunto de credenciales. El historial de llamadas incluye los siguientes elementos:

• Completado: La marca de tiempo cuando se realizó la llamada (zona horaria UTC).

• Detalles de la llamada: Detalles sobre la llamada, incluida la descripción, la URL de la documentación y el título.

• Región: La región donde ejecutó la llamada, como DFW u ORD.

• Solicitud: Las partes de la solicitud que se guardan como referencia incluyen la URL, el verbo y cualquier objeto de datos pasado a la API.

• Respuesta: El cuerpo de la respuesta, los encabezados de la respuesta y el código de la respuesta.

• Nombre de usuario: El nombre de usuario del usuario que está ejecutando las llamadas contra la API.

• Número de cuenta: El número de cuenta de la nube.

Llamadas repetidas con frecuencia

Si tiene una llamada que ejecuta con frecuencia, haga clic en el icono de estrella junto a la llamada. Esto lo agrega a sus favoritos, y puede acceder a estas llamadas desde la página principal o desde Favoritos en el menú. Solo puede agregar o ver sus favoritos cuando haya iniciado sesión en la aplicación.