Лого vc.ru

Как заставить разработчиков полюбить ваш API — опыт what3words

Как заставить разработчиков полюбить ваш API — опыт what3words

Авторы топонимического геолокационного сервиса what3words, который присваивает любому месту на земле некоторую комбинацию из трёх слов (можно присвоить и одно слово — но это платная услуга) и про который мы уже писали, рассказали ЦП, как сделать свой API удобным и привлекательным для разработчиков. 

Своим опытом поделились генеральный директор проекта Крис Шелдик, менеджер по продукции и интеграциям Беттина Никвист и PR-директор Эрнест Василевский.

Поделиться

Все написанное ниже не относится к крупным компаниям вроде Twitter или «Яндекса». Их API не нуждается в продвижении, а разработчики готовы мучаться с ним, невзирая на возможные неудобства, несовершенства интерфейса и необходимые затраты. Все потому, что они очень хорошо себе представляют решаемую задачу и видят необходимость интеграции. Если ваш API менее востребован, и ему есть к чему стремиться, возможно, будет полезно узнать о нашем опыте.

Задача, с которой пришлось столкнуться в what3words, оказалась весьма необычной и невероятно сложной. Уговорить разработчиков геолокационных приложений и сервисов интегрировать поддержку совершенно новой системы адресации для каждой точки земного шара — очень и очень непросто. Даже тем, кто отлично понимал все плюсы w3w и нашего подхода к адресации, было достаточно сложно оторваться от текущих задач и переключиться на интеграцию, и это полностью исключало право на ошибку.

API — это практически ваше лицо, и оно не должно спугнуть разработчика. В случае с w3w, если он решит, что игра не стоит свеч, он спокойно вернется к почтовым адресам и GPS-координатам, с которыми его программа или сервис работали до сих пор. Чтобы быть настойчивым, нужно понимать, за что борешься, а это сложно, когда предлагается что-то кардинально новое — как what3words. Поэтому мы не стали пугать разработчиков и постарались сделать собственный бесплатный API максимально дружелюбным. Мы достигли в этом определенных успехов, и хотим поделиться своим опытом.

Откройте дверь

В w3w мы стараемся сделать API настолько приветливым, насколько это только возможно. Все начинается с регистрации, и тут даже маленький компонент, кажущийся несущественным, может напрочь убить процесс. Совсем не стоит тормозить разработчика на странице регистрации. API должен предложить решение комплексной проблемы, но если на его запрос уходит больше двух минут, игра проиграна.

Тестирование

Каждый, кто действительно планирует интеграцию API в собственный продукт, должен быть уверен, что решает свою проблему, и не последнюю роль в этом играет понимание того, как все работает.

Единственный способ вселить в разработчиков уверенность в том, что решение выполняет свое предназначение, — это дать им возможность его протестировать. В API w3w запросы GET и POST доступны в равной степени, поэтому разработчики могут моментально протестировать его в своем браузере. Для того, чтобы сделать все более наглядным, мы также добавили отображение примеров с фрагментами кода на разных языках (PHP, jQuery Linux curl).

Бесшовная интеграция

Процесс интеграции API должен быть простым и очевидным. Таким, чтобы разработчикам не пришлось писать (или, что еще хуже, звонить) команде поддержки. И уж точно он не должен быть вызывающим желание отказаться от идеи интеграции. Любые препятствия, не имеющие логичного решения, могут стать гвоздем в гробу API.

В w3w мы стремимся сделать процесс интеграции настолько простым и быстрым, насколько это только возможно. Нам известно о своеобразном рекорде — 20 минут от начала регистрации до готовой установки — что кажется нам достаточно быстрым.

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

Доступная трактовка ошибок

При вызовах API неизбежно будут возникать ошибки. Мы вложили немало усилий в составление сообщений об ошибках. Эти сообщения должны быть понятными и информативными. В документацию к API мы включили справочник со всеми возможными ошибками и их отображаемым кодом.

Стоит поработать над тем, чтобы нужную ошибку можно было быстро найти и распознать. Ваши усилия способны сберечь нервы разработчика и его хорошее настроение.

Поощрение шалостей

Мы любим разработчиков, которым хочется построить что-то над нашим API, создать расширения, которые могут стать полезными для других пользователей. Мы призываем сообщество разработчиков создавать хаки поверх хаков — как это сделали, например, разработчики из Nestoria (одного из наших новых партнеров), создавшие библиотеку API для Perl.

Опыт помогает совершенствовать интерфейс, и нет ничего плохого в том, чтобы задействовать чужой опыт.

Конечно же, поставить себя на место разработчика и учесть все нюансы очень сложно, но когда у вас есть созданный интерфейс, способный быть полезным, стоит потрудиться ради его успеха. Благодаря усиленной работе нам удалось завоевать новых партнеров. Мы хотим, чтобы наш опыт пошел всем на пользу. Желаем успешных интеграций и новых рекордов скорости.


Чтобы написать колонку для ЦП, ознакомьтесь с требованиями к публикуемым материалам.

Статьи по теме
Как послать кого-то тремя словами — топонимический проект what3words28 ноября 2013, 11:59
Популярные статьи
Показать еще
Комментарии отсортированы
как обычно по времени по популярности

Эм, а как с доками дела?

0

было бы классно перед тем как расписывать, какой у вас удобный апи, описать пару кейсов - кому и зачем он может понадобиться.

Колонка вовсе не о нашем API, она о хорошем API. Просто мы считаем свой интерфейс отличным примером, и гордимся им. А кейсы его использования предельно просты. w3w - это система координат, встраиваемая в любые карты, которая проще и точнее GPS-координат и незнакомых почтовых адресов.

0

Мне потребовалось минут 15, чтобы понять, что вы делаете и почему это круто (а это правда круто!). Если бы не товарищ, который залип с поиском нашего офиса, так бы я ничего и не узнал. Ну, о том, что любой хороший API начинается с документации кейсов, видимо, вам говорить не надо.

0

Спасибо за Ваш отзыв!
В этой статье мы постарались сконцентрироваться на советах по улучшению своего API. Материалы о пользе нашего сервиса и его отличительных особенностях уже выходили, в том числе и на страницах "ЦП": siliconrus.com/2013/11/what3words/

0

Написали бы чем закончились переговоры с Яндексом.
А то поиск там до сих пор не работает.

Некоторые геолокационные и картографические сервисы, которые уже интегрировали наш API, пришли к этой идее благодаря пользователям. Пользователи просили разработчиков их любимых приложений и сервисов добавить поддержку what3words. Мы будем рады, если активные пользователи Яндекс.Карт обратятся с этим пожеланием в службу поддержки. Быть может это сыграет решающую роль.

0

Возможность комментирования статьи доступна только в первые две недели после публикации.

Сейчас обсуждают
Hovhannes Frangulyan

В своё время это здание хотел приобрести Роман Абрамович и построить в нём стадион для Челси, но власти не разрешили

Apple откроет новую лондонскую штаб-квартиру для 1400 сотрудников в здании бывшей электростанции Баттерси
0
Cooler Sollt

жаль, телефоны у них были отличные, у меня всё меньше времени, чтоб взять новый Passport!

Blackberry официально отказалась от производства смартфонов
0
Elegar Helfrid

Ни одного успешного проекта? Вы серьезно?
play.google.com/store/apps/developer?id=Ubisoft+Entertainment

Ubisoft приобрела компанию Ketchapp — издателя 2048, ZigZag и других мобильных игр
0
Eugene

Автор хочет попиариться на горячей теме, объективность при такой постановке только мешает.

Письмо в редакцию: «У вас проблемы с бизнесом, если больше 40% заказов — из "Яндекс.Маркета"»
0
Mark Markov
AdRegain

Текущие масштабы и темпы роста процента адблокеров сведут затею Google на нет.

Google представила проект развития бесплатного Wi-Fi по всему миру
0
Показать еще