Pitchfork - l'applicazione web dell'API Rackspace Cloud

Se desideri un modo interattivo per fare riferimento alla documentazione ed eseguire comandi API per i prodotti Rackspace Cloud, devi interagire rapidamente con un prodotto, oppure vuoi sfruttare nuovi prodotti o funzionalità che non sono disponibili nel Pannello di controllo, Pitchfork potrebbe essere lo strumento per tu.

Pitchfork è un'applicazione API Web interattiva che consente a un utente di interagire rapidamente con i prodotti Rackspace Cloud. Non è necessario richiamare un prompt dei comandi o cercare come inviare oggetti dati utilizzando un comando cURL. L'applicazione gestisce tutto questo per te e mostra i risultati e le risposte dalle richieste dell'API del prodotto che hai effettuato sul tuo account Cloud.

Pitchfork è stato progettato per effettuare chiamate API e mostrarti di cosa hai bisogno per le chiamate API in modo da poterle eseguire utilizzando altri strumenti o metodi. Puoi utilizzare la funzione di simulazione per controllare la struttura dei dati per una chiamata, che può fungere da strumento di riferimento nei tuoi programmi API Rackspace.

Le API possono creare confusione per i principianti. Poiché Pitchfork definisce la struttura delle chiamate per te, puoi imparare molto più rapidamente. A volte l'API è l'unico modo per apportare una modifica alla configurazione su un sistema di bilanciamento del carico o su un database cloud, ad esempio, e Pitchfork può mostrarti come effettuare la chiamata ed eseguirla per te.

Dove trovare Pitchfork

Puoi accedere a Pitchfork al seguente indirizzo:https://pitchfork.rax.io

Guarda il codice in GitHub.

Requisiti di accesso

Non è necessario accedere all'applicazione per prendere in giro o sfogliare le chiamate API. Devi accedere solo se desideri eseguire quelle chiamate sul tuo account.

Per accedere, fai clic su Accedi e inserisci le tue credenziali di autenticazione.

Autenticazione

Pitchfork utilizza le stesse credenziali che utilizzi in una richiesta di autenticazione API a Rackspace Cloud. Fornisci il tuo nome utente e la chiave API e il sistema effettua la richiesta di autenticazione per te su HTTPS. Se la richiesta ha esito positivo, l'applicazione archivia il token e il catalogo del servizio che viene restituito e fa scadere la sessione insieme al token quando è il momento.

Utilizza Pitchfork per inviare una chiamata API

Dopo aver effettuato l'accesso, utilizza i seguenti passaggi per inviare una chiamata API utilizzando Pitchfork:

1. Sfoglia uno qualsiasi dei prodotti e trova la chiamata che desideri eseguire.
2. Scegli la regione con cui vuoi interagire.
3. Fai clic su Dettagli .
4. Se ci sono variabili per la chiamata, inseriscile.
5. Fai clic su Invia chiamata API .

L'applicazione mostra le seguenti informazioni:

• URL di richiesta: L'URL completamente costruito a cui hai inviato la chiamata.

• Intestazioni delle richieste: La parte delle intestazioni della richiesta che hai inviato all'API.

• Richiedi oggetto dati: Se è presente un oggetto dati creato per la chiamata, viene visualizzato includendo i valori specificati.

• Intestazioni di risposta: Le intestazioni ricevute nella risposta dall'API.

• Ente di risposta: I dati di risposta dal server API. Questa risposta potrebbe includere un codice di stato, un oggetto restituito o un messaggio di errore.

• Nota: Le intestazioni della risposta e il corpo della risposta vengono mostrati solo per le chiamate eseguite e non per le simulazioni di chiamata. Poiché le simulazioni non vengono eseguite, non viene visualizzata alcuna risposta.

Mock

L'opzione mock ti consente di creare una chiamata senza eseguirla in modo da poter vedere come è strutturata la chiamata. Fai clic su Chiamata API simulata quando vuoi vedere tutti i dettagli della richiesta per una chiamata. L'oggetto dei dati della richiesta, se presente, viene mostrato con tutte le opzioni disponibili per la chiamata e, per riferimento, puoi vedere come è strutturato l'oggetto.

Avvertenze per l'esecuzione delle chiamate

Una volta effettuato l'accesso, le chiamate vengono eseguite sul tuo account Cloud. Ci sono note sulle chiamate per avvisarti quando stai facendo qualcosa che influirà sulla fatturazione, quindi fai attenzione quando esegui le chiamate.

Quando prendi in giro una chiamata, non viene eseguita alcuna chiamata API, quindi non c'è alcun impatto sul tuo account.

Cronologia chiamate

Puoi visualizzare facilmente la cronologia delle chiamate effettuate facendo clic su Cronologia nel menu. La cronologia mostra le chiamate effettuate insieme a tutti i dettagli. La cronologia viene salvata per le chiamate eseguite sull'API indipendentemente dalla risposta. Le false chiamate API non vengono registrate nella tua cronologia. Devi essere loggato per vedere la tua cronologia.

La cronologia delle chiamate viene salvata per consentire di controllare o fare riferimento alle chiamate passate effettuate all'interno del sistema. Ciò è utile quando più utenti utilizzano lo stesso set di credenziali. La cronologia delle chiamate include i seguenti elementi:

• Completato: Il timestamp in cui è stata effettuata la chiamata (fuso orario UTC).

• Dettagli chiamata: Dettagli sulla chiamata, inclusa la descrizione, l'URL della documentazione e il titolo.

• Regione: La regione in cui hai eseguito la chiamata, ad esempio DFW o ORD.

• Richiesta: Le parti della richiesta salvate come riferimento includono l'URL, il verbo e qualsiasi oggetto dati passato all'API.

• Risposta: Il corpo della risposta, le intestazioni della risposta e il codice della risposta.

• Nome utente: Il nome utente dell'utente che sta eseguendo le chiamate sull'API.

• Numero di conto: Il numero dell'account Cloud.

Chiamate ripetute frequentemente

Se hai una chiamata che esegui di frequente, fai clic sull'icona a forma di stella accanto alla chiamata. Questo lo aggiunge ai tuoi preferiti e puoi accedere a queste chiamate dalla prima pagina o da Preferiti nel menu. Puoi aggiungere o visualizzare i tuoi preferiti solo dopo aver effettuato l'accesso all'applicazione.