API

Бесплатные API для веб-мастеров

Наш API позволяет веб-мастерам отправлять запросы в нашу базу аккордов и публиковать наши схемы (и не только) на своих вебсайтах. Всё, что вам нужно - это действительный ключ API (+ ссылка обратно на https://ukulele-chords.com) - получите её бесплатно!

Как это работает?

Вот как получить доступ к данным ukulele-chords.com

URL API: ukulele-chords.com/get?
Параметры : "ak" (ваш API-ключ), "r" (основной тон аккорда), "typ" (тип аккорда), "sk" (слэш-аккорд) и "uke" (строй)
Все параметры, кроме "sk" и "uke", являются обязательными
r - это основной тон аккорда. Здесь можно указать "A", "Bb", "B" , "C", "Db", "D", "Eb", "E", "F", "Gb", "G" и "Ab"
typ - это тип аккорда. Здесь можно указать "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 - это альтерированный основной тон слэш-аккорда. Опционально. (Допустимые значения: см. "r")
uke - это строй. Здесь можно указать "soprano" (значение по умолчанию), "baritone" (баритоновый, G), "d-tuning" (ре-мажорный строй) или "slack-key". Опционально.
Пример: чтобы запросить информацию об аккорде Csus2, вызовите наш API: "http://ukulele-chords.com/get?ak=your_api_key&r=C&typ=sus2"

Выход (в формате XML)

chord_name Название аккорда...
chord_diff Сложность (из 10)
chord_diag Схема аккорда (200x250)
chord_diag_mini Схема аккорда (90x130)
chord_photo Фото (возвращает "false", если у нас нет фото)
chord_url Ссылка на Ukulele-chords.com для более подробной информации

Возвращает "false", если запрашиваемый аккорд не найден.

Рабочий пример в PHP

Не знаете, как пользоваться нашим API? Вот рабочий пример того, как получить схему аккорда 'C Major' при помощи расширения SimpleXML (платформенно-ориентированный с PHP 5.0):


<?php
//XML-файл для загрузки
$api_url = 'http://www.ukulele-chords.com/get?ak=YOUR_API_KEY&r=C&typ=major';
//конвертирует указанный XML-файл в объект SimpleXMLElement
$xml = simplexml_load_file($api_url);
//Осуществляйте навигацию по дереву, чтобы получить нужную информацию (схема аккорда здесь)
//аккорд[0] возвращает "основной аккорд". Для альтернативных обращений используйте цикл foreach().
$res = $xml->chord[0]->chord_diag_mini;
//распечатать результат
echo '<img class="lazy" src="/img/img_load.png" data-src="'. $res .'" alt="" width="90" height="130" />';
?>

Пожалуйста, свяжитесь с нами или зайдите на нашу страничку в Facebook, если вам понадобилась помощь в использовании нашего API.