API

API gratuita para webmasters

Nossa API permite que os webmasters consultem facilmente nosso banco de dados de acordes e publiquem nossos diagramas (e mais) em seu site. Tudo que você precisa é de uma chave de API válida (+ um link de retorno para https://ukulele-chords.com), obtenha uma gratuitamente!

Como funciona?

Aqui está como acessar os dados do ukulele-chords.com

  • URL da API: ukulele-chords.com/get?
  • Parâmetros: "ak" (sua chave API), "r" (nota fundamental do acorde), "typ" (tipo de acorde), "sk" (acorde slashed) e "uke" (Afinação)
  • Todos os parâmetros são obrigatórios, exceto "sk" e "uke"
  • r é a nota fundamental do acorde. Pode ser definido como "A", "Bb", "B" , "C", "Db", "D", "Eb", "E", "F", "Gb", "G" e "Ab"
  • typ é o tipo de acorde. Pode ser definido como "major", "m", "aug", "dim", "7", "m7", "maj7", "m7b5", "sus2", "sus4", "7sus4", "9", "11", "13", "6", "m6", "add9", "m9", "5", "dim7", "m13", "7sus2", "mMaj7", "m11" and "maj9".
  • sk é a nota fundamental alterada de um acorde slash. Opcional. (Valores aceitos : ver "r")
  • uke é a afinação. Pode ser definido como "soprano" (valor padrão), "baritone" (Afinação G), "d-tuning" ou "slack-key". Opcional.
  • Exemplo: para consultar infos do acorde Csus2, chame nossa API: "http://ukulele-chords.com/get?ak=your_api_key&r=C&typ=sus2"

Saída (formato XML)

  • chord_name O nome do acorde...
  • chord_diff Dificuldade (em 10)
  • chord_diag Diagrama do acorde (200x250)
  • chord_diag_mini Diagrama do acorde (90x130)
  • chord_photo Figura (retorna "false" se não houver a imagem)
  • chord_url Link para o Ukulele-chords.com para mais informações

Retorna false se o acorde solicitado não for encontrado.

Exemplo PHP

Não tem certeza sobre como usar a nossa API? Aqui está um exemplo de trabalho para obter um diagrama de acorde 'C Maior' usando a extensão SimpleXML (nativo desde o PHP 5.0):

<?php
//arquivo XML para carregar
$api_url 'http://www.ukulele-chords.com/get?ak=YOUR_API_KEY&r=C&typ=major';
//converte o arquivo XML especificado em um objeto SimpleXMLElement
$xml simplexml_load_file($api_url);
//Navega pela árvore para obter as informações (diagrama de acordes aqui)
//chord [0] retorna o "acorde principal". Para posições alternativas, use um loop foreach().
$res $xml->chord[0]->chord_diag_mini;
//imprime o resultado
echo '<img class="lazy" src="/img/img_load.png" data-src="'$res .'" alt="" width="90" height="130" />';
?>

Por favor, entre em contato ou visite a nossa Página do Facebook se você precisa de ajuda para usar nossa API.


© 2011-2019 Ukulele-chords.com