Какво е API обяснение за журналисти, най-доброто приложение

За мултимедийната журналистика

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

Най-добрите видео уроци за приложения

Визитката е кликаема!

Какво е API: обяснение за журналисти

Споделете „Какво е API: обяснение за журналисти“

Думата API се носи в медийната среда през последните няколко години. Това означава "Интерфейс за програмиране на приложения". API позволява на компютърните програми да взаимодействат една с друга по различни начини и им позволява да обменят данни помежду си.

За да извлече максимума от API, добросъвестният разработчик често създава ръководство, наречено документация. Няма единен стандарт за документацията на API: тя може да бъде както подредена и визуална, така и хаотична и непълна.

Няма много ресурси, които обясняват същността на API документацията за не-програмисти. И тъй като няма специфичен стандарт във формата, е трудно да се напише ръководство за четене на ръководството, което да е подходящо за всички. Но ако имате работа с добре написана API документация, струва си да прочетете бърз преглед на това как да се ориентирате в нея.

ОСНОВЕН ВЪПРОС: КАКВО МОЖЕ ДА МИ ДАДЕ ТОЗИ ИНТЕРФЕЙС?

Потърсете в интернет думата „заявки“. Ако не намерите нищо, опитайте да потърсите думите „REST API“ или нещо подобно на последната част от URL.L.

В тези раздели обърнете внимание на думите „вземете“ и „поставете“. Те се наричат методи, които могат да бъдат изпълнени чрез определени API действия. (Някои разработчици може да ги наричат функции, но ние все още ще използваме термина "методи").

Ако документацията е написана на обикновен език, няма да е трудно да се разбере кой метод се изпълнява. В противен случай, за даза да дефинирате метод, ще трябва да намерите някой с повече опит в програмирането. Но помнете:

В КАКЪВ ФОРМАТ МОГА ДА ПОЛУЧА ДАННИТЕ?

Обикновено API ви позволява да изберете типа на данните, тази функция е известна още като „формат на отговора“. Ще видите или „json“, или „XML“. Понякога можете да видите „txt“ или други формати. Най-добрият формат се определя от разработчика, но като минимум ще знаете кои са налични.

За да намерите опции за формат, потърсете думите „формат“ или „отговор“. Понякога се споменава в началото на документацията, понякога „формат“ може да се намери в методите.

КАКВО МИ ТРЯБВА В ЗАМЕНА, ЗА ДА ПОЛУЧА НЕОБХОДИМИТЕ МИ ДАННИ?

Понякога е възможно да направите заявка към API инкогнито. Но създателите на API често искат да знаят как и от кого се използва. В допълнение, те искат да предотвратят претоварването на сървъра и лудориите на разработчиците, така че много API заявки изискват уникален идентификатор на лицето или програмата, които правят заявката.

Получаването на такъв ключ обикновено не е трудно. Потърсете думата „удостоверяване“ или „API ключ“ за допълнителни инструкции и за да видите кой метод изисква удостоверяване.

МОГА ЛИ ДА ТЕСТВАМ ЗАЯВКИ ЗА API ДОРИ И ДА НЕ СЪМ РАЗРАБОТЧИК?

да Можете да създадете своя собствена заявка за тест, като копирате примерния отговор в метода и модифицирате променливите (обикновено наричани „параметри“).

Например, нека се опитаме да намерим информация за филми от поредицата Хари Потър в XML формат в рецензиите на New York Times. Използвайте всяка търсеща машина, за да намерите API за рецензии на филми на The New York Times. Този API не е перфектен (все пак е само бета версия). Алгоритъмът, който ще опишем, може лесно да бъде съкратен, когато имате повече опит, но заза първи път отиваме по дългия път.

ТАКА ЧЕ НИЕ СМЕ НА СТРАНИЦАТА API:

1. Намерете нещо, което ще ви помогне да получите общ преглед чрез ключови думи. В този случай това е методът „Рецензии по ключова дума“. Вътре има описание с примерен URI (маркиран в тъмно сиво). Това е вашият шаблон за заявка.

Този метод има два задължителни параметъра: версия, т.е. API версия (v2) и API ключ, които можете да получите тук.

ПЪРВОНАЧАЛЕН ИЗГЛЕД:

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

2. След това въвеждаме два допълнителни параметъра, които са описани малко по-късно в същия раздел на документацията на API за филмови рецензии:

Формат на отговора, а именно: .xml Ключова дума за заявка: „Потър“ (Търсенето на фразата „Хари+Потър“ няма да работи. Поне в бета версията). В резултат на това ще получим набор от данни от първия филм до последния. Както се казва в документацията, форматът на диапазона е ГГГГ-ММ-ДД;ГГГГ-ММ-ДД. Затова ще въведем следните параметри: дата на отваряне=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: обяснение за журналисти“