Je ne comprends pas comment utiliser cette API

Question

Je commence actuellement un projet avec cette API, guitarparty. Le problème est que je ne sais pas comment l'utiliser.

par exemple, cette ligne

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songbooks/ 

Je ne sais même pas où je suppose que de le placer. Quelqu'un pourrait-il montrer un exemple comment l'utiliser? Comme, juste pour demander une chanson.

L'API semble vraiment simple. Le problème est que je ne sais pas comment commencer. Merci.

Les documents d'api sont vraiment courts, mais je ne comprends pas par où commencer.

http://www.guitarparty.com/developers/api-docs/api-resources/songs/#available-song-methods

Answer 1

friser est un outil de ligne de commande pour travailler avec des protocoles HTTP et similaires. Vous pouvez le télécharger ici: http://curl.haxx.se

La ligne est destinée à être entrée dans une ligne de commande sur un système qui a installé curl, peut-être sur un système de type Linux. Vous pouvez télécharger curl et essayez de suivre avec l'exemple. Cependant, la beauté d'une API comme celle-ci est que vous n'avez pas besoin d'utiliser un outil particulier - vous pouvez utiliser n'importe quel outil, tant que vous pouvez définir des valeurs d'en-tête HTTP. Beaucoup d'outils et de modules différents peuvent faire des requêtes HTTP.

La première chose à faire est d'acquérir une clé API sur le site GuitarParty. Ceci est une clé qui permettra d'identifier votre application, et probablement mettre certaines restrictions sur, par exemple. combien de requêtes vous pouvez exécuter. Sans un, vous ne serez pas autorisé à utiliser l'API. Vous êtes censé remplacer "{API_KEY}" dans ce qui précède par une clé API réelle.

Un exemple d'une requête (de la documentation) est:

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songs/?query=Jolene 

Qu'est-ce qui se passe ici est que boucle est utilisé pour faire une requête GET normale via HTTP. C'est le genre de requête que votre navigateur fait normalement lorsque vous cliquez sur un lien. L'URL est "http://api.guitarparty.com/v2/songs/?query=Jolene" - c'est ce que vous souhaitez modifier pour rechercher des chansons autres que "Jolene". La seule chose étrange qui se passe est qu'une valeur d'en-tête HTTP personnalisée est en cours de définition: "Guitarparty-Api-Key", à la clé de l'API. -H est la syntaxe curl à faire pour définir un en-tête personnalisé.

En réponse, à partir du serveur, vous retournerez une structure codée en JSON avec le résultat de la recherche. Vous aurez besoin d'analyser cette structure et d'extraire les parties qui vous intéressent.

Pour entrer dans n'importe quelle sorte de détails - comment faire une requête HTTP avec des en-têtes spéciaux, comment analyser JSON - j'aurais pour savoir quel type de langage ou d'environnement vous envisagez de travailler. Pour Python, par exemple, je vous conseille de regarder les modules "urllib2" et "json".