Що таке API пояснення для журналістів, Best app

Про мультимедійну журналістику

Спецпроекти Bestapp.menu

best

Відеоуроки Best app

журналістів

Візитка клікабельна!

пояснення

Що таке API: пояснення для журналістів

"Що таке API: пояснення для журналістів"

Слово API гуляє медіасередовищом вже останні кілька років. Розшифровується як «інтерфейс програмування додатків». API дає можливість комп'ютерним програмам взаємодіяти один з одним у різний спосіб і дозволяє їм обмінюватися між собою даними.

Щоб отримати максимальну користь від API, сумлінний розробник найчастіше створює керівництво, яке називають документацією. Для API документації немає єдиного стандарту: вона може бути як упорядкованою і наочною, так і хаотичною і неповною.

Не так багато ресурсів, які пояснюють суть API документації для непрограмістів. І оскільки у форматі немає певного стандарту, складно написати відповідний для всіх посібник з читання мануалу. Але якщо ви маєте справу з добре написаною документацією API, варто прочитати короткий огляд про те, як у ній розібратися.

ОСНОВНЕ ПИТАННЯ: ЩО МЕНІ МОЖЕ ДАТИ ЦЕЙ ІНТЕРФЕЙС?

Пошукайте в інтернеті згадку слова "requests". Якщо ви нічого не знайшли, то спробуйте відшукати слова "REST API" або щось схоже на останню URL.L.

У цих розділах зверніть увагу на слова "get" та "post". Вони називаються методами, які можуть бути виконані певними діями API. (Деякі розробники можуть називати їх функціями, але ми все ж таки будемо використовувати термін «методи»).

Якщо документація написана простою мовою, не складе особливих труднощів зрозуміти, який метод виконується. В іншому випадку, щобвизначити метод, вам доведеться знайти когось із великим досвідом програмування. Але пам'ятайте:

У ЯКОМУ ФОРМАТІ Я МОЖУ ОТРИМАТИ ДАНІ?

Зазвичай API дозволяє вибирати вид даних, ця функція також відома під назвою формат відповіді. Ви побачите або "json", або "XML". Іноді можна зустріти txt або інші формати. Найкращий формат визначається розробником, але, як мінімум, ви знатимете, які з них доступні.

Щоб знайти опції формату, шукайте слова "format" або "response". Іноді він згадується на початку документації, іноді «format» можна знайти у методах.

ЩО ПОТРІБНО ВЗАМІН НА ОТРИМАННЯ ПОТРІБНИХ МЕНІ ДАНИХ?

Іноді можна здійснити запит до API інкогніто. Але творці API часто хочуть знати, як і ким він використовується. На додаток, вони хочуть запобігти перевантаженню сервера і позбутися витівок розробників, тому у багатьох запитах до API потрібен унікальний ID людини або програми, які роблять запит.

Отримання такого ключа зазвичай не викликає труднощів. Знайдіть слово «автентифікація» або «ключ API», щоб отримати подальші інструкції та дізнатися, який метод потребує аутентифікації.

МОЖУ Я ПРОТЕСТУВАТИ ЗАПИТАННЯ ДО API, НАВІТЬ ЯКЩО Я НЕ РОЗРОБНИК?

Так. Ви можете створити свій власний тестовий запит, скопіювавши приклад відповіді у методі та змінивши змінні (як правило, їх називають «параметрами»).

Наприклад, спробуємо знайти в оглядах New York Times інформацію про фільми з серії Гаррі Поттер у форматі XML. Скористайтеся будь-якою пошуковою системою, яка вам подобається знайти The New York Times movie reviews API. Цей API не є ідеальним (у будь-якому випадку, це просто бета-версія). Алгоритм, який ми опишемо, можна скоротити, коли у вас з'явиться більше досвіду, але дляпершого разу ми підемо довгим шляхом.

ОТЖЕ, МИ НА СТОРІНЦІ API:

1. Знайдіть те, що допоможе вам отримати огляд за допомогою ключових слів. В даному випадку це метод “Reviews by Keyword”. Усередині є опис із прикладом URI (він виділений темно-сірим кольором). Це шаблон вашого запиту.

У цьому вся методі два обов'язкових параметра: version, тобто. версія API (v2) та ключ API, який можна отримати тут.

ВИХІДНИЙ ВИГЛЯД:

http://api.nytimes.com/svc/movies/v2 /reviews/search[.response_format] ?[optional-param1=value1]&[… ] &api-key=

2. Потім введемо два додаткові параметри, які описані нижче в цьому розділі Movie Reviews API documentation:

Формат відповіді, а саме: .xml Ключове слово запиту: “Potter” (Пошук словосполучення “Harry+Potter” працювати не буде. Принаймні у бета-версії). У результаті ми отримаємо діапазон даних, починаючи з першого фільму до останнього. Як зазначено в документації, формат діапазону: YYYY-MM-DD; YYYY-MM-DD. Тому введемо такі параметри: opening-date = 2001-11-01; 2011-07-31.

Тепер ваш приклад URI має виглядати так (нові параметри виділено):

http://api.nytimes.com/svc/movies/v2/reviews/search.xml ?&query=Potter&opening-date=2001-11-01;2011-07 -31 &api-key=

Вуаль! Ви тільки створили свій перший API запит та отримали огляди фільмів Гаррі Поттер.

Деякі чудові розробники створюють також консоль, сендбокс та порожні форми для заповнення. Це дозволяє протестувати ваш запит без написання його вручну. А ще краще інструменти, які грамотно генерують і запит, і результат. Ви та ваш розробник можете скопіювати їх та використовувати, як забажаєте.

Кріс Ву –журналіст, стратег, програміст та кухар. Коли вона не займається консультацією клієнтів щодо залучення користувачів та створення спільнот, вона організовує зустрічі на Hacks/Hackers, де збираються журналісти, розробники та дизайнери для того, щоб перезапустити новини. Її твіттер: @ MacDiva.

"Що таке API: пояснення для журналістів"