Что значит api? как понять аббревиатуру api? перевод и расшифровка

API — это… Что такое API?

Что значит api? Как понять аббревиатуру api? Перевод и расшифровка

  • api — (d ) [ dapi ] loc. adj. • pomme d api 1653; pomme apie 1571; lat. appiana (mala) « pommes appiennes », c. à d. d Appius, qui les aurait introduites à Rome ♦ Anciennt Pomme d api : variété de pomme très rouge d un côté. Pomme de reinette et pomme… …   Encyclopédie Universelle
  • api — api·a·ca; api·a·ce·ae; api·a·ceous; api·an; api·ar·i·an; api·a·rist; api·ary; api·cian; api·cul·tur·al; api·cul·ture; api·cul·tur·ist; api·gen·in; api·in; api·ko·res; api·na·vé; api·ole; api·ol·o·gy; api·on; api·os; api·ose; api·o·so·ma;… …   English syllables
  • Api — Cette page d’homonymie répertorie les différents sujets et articles partageant un même nom. {{{image}}}   Sigles d une seule lettre   Sigles de deux lettres > Sigles de trois lettres …   Wikipédia en Français
  • API — (de or. quechua; Arg., Bol.) m. *Maíz blanco molido y cocido que se come en frío, generalmente con leche y azúcar. * * * api. (De or. quechua). m. NO Arg. y Bol. Mazamorra de maíz morado triturado, sazonada con diversos ingredientes …   Enciclopedia Universal
  • API — steht für: Active Pharmaceutical Ingredient, englische Bezeichnung für einen Arzneistoff (Wirkstoff) in einem Medikament Adaptive Planungsintelligenz, mathematische Methoden für industrielle Planungsaufgaben African Plants Initiative, ein Projekt …   Deutsch Wikipedia
  • api d' — api (d ) [ dapi ] loc. adj. • pomme d api 1653; pomme apie 1571; lat. appiana (mala) « pommes appiennes », c. à d. d Appius, qui les aurait introduites à Rome ♦ Anciennt Pomme d api : variété de pomme très rouge d un côté. Pomme de reinette et… …   Encyclopédie Universelle
  • Api — steht für: Active Pharmaceutical Ingredient, englische Bezeichnung für einen Wirkstoff in einem Medikament Adaptive Planungsintelligenz, mathematische Methoden für industrielle Planungsaufgaben African Plants Initiative, ein Projekt zur Förderung …   Deutsch Wikipedia
  • api — API. s. m. Sorte de pomme, petite, et ordinairement colorée d un rouge assez vif. Des pommes d Api. Voilà de sort bel Api. J ai beaucoup d Api dans mon jardin …   Dictionnaire de l'Académie Française 1798
  • api — Element de compunere savantă care are semnificaţia referitor la albină , de albină . [< fr. api , lat. apis – albină]. Trimis de LauraGellner, 04.11.2004. Sursa: DN  API elem. albină . (< fr. api , cf. lat. apis) Trimis de raduborza, 15.09 …   Dicționar Român
  • API — sąsaja statusas T sritis informatika atitikmenys: angl. API ryšiai: žiūrėk – programų sąsaja …   Enciklopedinis kompiuterijos žodynas

Источник: https://dic.academic.ru/dic.nsf/avto/9/API

Спецификация масел по api: что нужно знать?

Смазочные материалы начали использоваться еще задолго до нашей эры. И если раньше в качестве них применялись растительные жиры и жиры животного происхождения, то начиная с 60-х годов прошлого века их заменили продукты нефтепереработки.

После этого началось активное развитие и совершенствование моторных масел, а около 70 лет назад появились первые полимерные модификаторы вязкости, благодаря которым вскоре в моторных маслах появились разные классы и разновидности, отвечающие температурному режиму определенного времени года, а также появились всесезонные виды смазочных материалов.

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

Среди основных общепринятых систем одной из самых известных является классификация моторных масел по API.

Она была введена в конце 50-х годов нашего века Американским Институтом Нефти, и основополагающим принципом в ней является классификация по двум категориям — S и C, то есть для бензиновых и дизельных двигателей соответственно.

Спецификации масел S и C

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

  • S – ServiceЭто ряд назначения и качества масел, рассчитанных для автомобилей с бензиновым мотором;
  • C – Commercial.Данный ряд назначения и качества масел, созданных для дизельных двигателей. Сюда входят автомобильные транспортные средства, а также сельскохозяйственная, строительная, дорожная и прочая техника. ;
  • EC – Energy Conserving.Это категория современных высококачественных смазочных материалов, которые производители называют энергосберегающими. Они прошли многочисленные исследования, которые показали, что эти продукты способны существенно сокращать расход топлива в автомобилях с бензиновыми двигателями.

Все эти стандарты обозначаются индексом из двух букв, например, SN, SM, SH, SG, CF, CI, где второе значение является показателем по уровню эксплуатационных характеристик. При этом, чем ближе к концу латинского алфавита находится буква, имеющаяся в обозначении, тем выше уровень масла по API. Например, такое обозначение на продукте как API SL, SM или SN означает превосходство над API SF.

Бензиновые двигатели: классы качества, их обозначения и расшифровка

Бензиновый двигатель

ГруппаОписание
SN Смазочные материалы SN отличаются от предшествовавших этой категории SM спецификаций тем, что в них содержится намного меньше фосфора, что наделяет их дополнительными энергосберегающими качествами и делает SN совместимыми с новейшими системами, направленными на нейтрализацию выхлопных газов. Класс SN утвержден осенью 2010 года и применяется в моторах самых современных автомобилей. Стоит отметить, что масла со спецификацией API SN по своим характеристикам близки ACEA C2, C3, C4, поэтому SN могут успешно заменять собой смазку класса SM.
SM SM впервые ввели в конце 2004 года. Этот класс сегодня более распространен, чем CN, ведь он предназначается для современных бензиновых моторов, включая много клапанные и турбированные двигатели. Смазка этой категории разрабатывалась с учетом совершенствования двигателей, поэтому призвана повышать их экологическую безопасность и быть более износостойкой. SM отличается от предыдущей категории SL большей стойкостью к окислению превосходными защитными свойствами от образования осадкой и отложений, что безусловно сказывается на высоком качестве смазочных материалов. Спустя два года после выпуска SM была разработана категория масел для дизельных моторов с обозначением CJ4.Продукты спецификации SM предназначены для автомобилей с 2004 года выпуска, и разработаны именно для них.
SL Класс SL был разработан незадолго до выхода SM и SN. Он разработан для двигателей автомобилей, выпущенных с 2001 года, и абсолютно отвечает всем современным стандартам и требованиям, включая высокую экологичность и энергосбережение. SL предназначаются для современных моторов, в том числе многоклапанных, турбированных и двигателей, приспособленных для работы на обедненных смесях топлива. На смазочных материалах группы SL вполне могут работать и двигатели, для которых предназначены продукты категории SJ.Благодаря таким свойствам, как пониженная летучесть, SL отличаются долгим сохранением своих качеств, благодаря чему интервал замены моторного масла заметно увеличивается. На сегодняшний день эта категория является действующей и широко применяется современными автовладельцами.
SJ Этот класс также является действующим на сегодняшний день. Его утвердили в ноябре 1995 года, хотя сертификацию продукт прошел лишь спустя год. Поэтому масла категории SJ используют для автомобилей с бензиновым двигателем, начиная с 1996 года выпуска. Их успешно применяют в моторах легковых и спортивных авто, а также в двигателях микроавтобусов и небольших грузовых машин.SJ показывает хорошие технические характеристики, в том числе устойчивость к образованию осадков и нагара, а также способность сохранять свои свойства при пониженных температурах. По этим свойствам масла категории SJ очень близки к продуктам класса SH, поэтому вполне пригодны для использования в том случае, когда автопроизводителем рекомендовано использование для машины масла категории SH.
SH Эта категория была создана в 1992 году и считается условно действующей. Масла, входящие в эту группу, применяются в моторах авто 1996 года выпуска и ранее. По своим качествам этот класс превосходит масла категории SG, ведь он разрабатывался с целью ее заменить. Поэтому масла класса SH успешно используются для автомобилей, в которых рекомендуется применять SG.
SG Класс SG предназначены для моторов, выпущенных в 1193 и раньше. Масла этой категории отличаются превосходной защитой от нагара и устойчивы к процессам окисления и образованию коррозии. Масла SG отвечают всем требованиям для моторных масел, предназначенных для дизельных двигателей API CC, а значит SG могут применяться для машин, в которых производитель рекомендует использовать категории SF и SF/CC, а также SE и SE/CC.

Спецификация масел для дизельных моторов

Среди современных спецификаций моторных масел наибольшей популярностью пользуются масла класса CI и CF. Именно они разработаны с учетом всех особенностей современных дизельных моторов и отвечают всем стандартам.

Дизельный двигатель BMW

CI Категория CI -4 утверждена в 2002 году. Они рассчитаны на различные дизельные моторы, продукты спецификации CI обладают высокой устойчивостью к окислению и содержат диспергирующие присадки. CI довольно экологичны, по сравнению с предыдущими классами масел. Стоит отметить, что из общей категории CI выделяют еще один класс — CI -4 PLUS. Усовершенствованный класс CI -4Plus выведен с учетом жестких требований к испаряемости масла, его окислению при повышенных температурах и образованию нагара.
CF Спецификация CF создана для дизельных моторов с непрямым впрыском. Они отличаются высоким содержанием различных присадок, которые предотвращают отложения на поршнях, а также защищают от износа и образования коррозии внутренних деталей с содержанием меди, к примеру, подшипников. Класс CF может иметь обозначения CF-4 и CF-2, что значит автомасла, предусматривающие применение в четырехтактных и двухтактных (соответственно) дизельных двигателях.При этом CF-4 рассчитаны на двигатели, работающие в ускоренном режиме, а CF-2 идеально подходят для моторов, которые постоянно подвергаются повышенным нагрузкам.

Видео «Классификации API»

Похожие публикации

Источник: http://MotorOilClub.ru/harakteristiki/spetsifikatsiya-motornyx-masel.html

Что такое API и как этим пользоваться?

Готовы узнать все об API? Что такое аффилированный API, и как вы можете этим пользоваться?

Тогда поехали!

Введение

Вы наверное безумец, если не согласны со следующим утверждением:

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

Однако, вам кажется, что вы не совсем понимаете что это такое.

Возможно, вам хотелось бы знать, какие приложения используются для API, как ими пользоваться, и как они будут влиять на работу аффилиатов в будущем?

Не беспокойтесь! Эта статья – то, чего вы так долго ждали!

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

К концу прочтения статьи вы будете знатоком этой темы!

Хватит вступлений. Начнем, пожалуй!

Что такое API?

Сейчас, скорее всего, вы задаетесь вопросом: “как расшифровывается API?”

API это Application Program Interface или программный интерфейс приложения.

Это определенный набор протоколов, подпрограмм и инструментов для создания программных приложений.

API это то, что позволяет настроить как разные компоненты программы должны эффективно взаимодействовать.

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

API: прагматическое использование

API изначально использовался в качестве метода отправки команд и информации определенного формата с одних программ на другие.

Проще говоря, это то, что обеспечивает эффективный процесс коммуникаций между программами, использующими функции и ресурсы друг друга.

API предоставляются теми программами, которые позволяют коммуникации с другими программами.

Представьте, что вы хотите разработать программу.

Вы пишете код и программируете как профессионал.

И что теперь?

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

Но как?

Просто!

Посмотрите на документацию API, чтобы эффективно собрать информацию и проверить список доступных функций.

Что было до API?

API существовал не всегда. Его появление на рынке стало технологической революцией и внесло много изменений в онлайн мир.

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

В чем была проблема?

Этот контент мог бы быть идеальным, но сопровождался риском стать устаревшим и содержать недействительные ссылки.

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

С API процесс стал проще, так как API может синхронизировать информацию между программными приложениями.

Как API используются в контексте всемирной паутины?

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

Пример того, как используется API:

Источник: https://www.mobidea.com/academy/ru/shto-takoe-api/

Типы моторных масел, расшифровка цифр SAE и API — DRIVE2

Типы моторных масел

Масло, которое называют «Cинтетика» (на коробке обычно обозначается как Fully Synthetic), имеет синтетическую основу, полученную путем синтеза химических элементов.

Читайте также:  Что значит кесарево сечение? как понять кесарево сечение? смысл

Главные отличия «синтетики» — возможность задать ряд параметров наперед, еще при создании основы масла, а так же максимальное содержание различных присадок.

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

«Минералка» (зачастую на коробке обозначение Mineral), масло с минеральной основой, полученной из нефти путем ее обработки, оно значительно дешевле.

Однако такое масло не обеспечивает тех же максимальных эксплутационных результатов, что и «синтетика» — оно не выдерживает столь высоких температур, сильнее густеет на морозе, быстрее окисляется и требует замены, при вскипании — оставляет шлаки в моторе.

«Полусинтетика» (обозначение Semi-Synthetic) — некая золотая средина между двумя предыдущими видами масел. Зачастую полусинтетика создана на минеральной основе, но с добавлением большого количества различных присадок, приближающих эксплуатационные свойства этого масла к «синтетике». При этом «полусинтетика» несколько дешевле «синтетики».

У моторного масла выделяют два главных параметра, по которым проводится его классификация — область его применения (дизельный мотор, старый бензиновый двигатель, современный турбодизель и т.д.) и вязкостно-температурные свойства. Невзирая на различные основы масел, все они классифицируются согласно одним стандартам. Сегодня наиболее популярны классификации по SAE и API.

Вязкостно-температурные свойства классифицируются только по SAE (Society of Automotive Engineers) — иными словами, именно показатель SAE регламентирует насколько это масло «густое» или «жидкое». Большинство масел сегодня — «универсальные», т.е.

пригодны и для зимнего, и для летнего использования. Их класс SAE записывается двумя цифрами через дефис, с буквой в промежутке W — например 10W-40.

Буква W означает, что это масло пригодно для зимнего использования, а цифра перед ней — это показатель низкотемпературной вязкости (грубо говоря — какой мороз выдержит это масло). Вторая цифра — это показатель высокотемпературной вязкости (т.е.

какую летнюю жару выдерживает масло). Однако если масло пригодно только для летнего использования, то его обозначение будет выглядеть, например, как SAE 30.

Расшифровка цифр SAE

Показатели низкотемпературной вязкости означают следующее:

* 0W- масло пригодно к использованию при морозах до -35-30 град. С* 5W- масло пригодно к использованию при морозах до -30-25 град. С* 10W- масло пригодно к использованию при морозах до -25-20 град. С* 15W- масло пригодно к использованию при морозах до -20-15 град. С

* 20W- масло пригодно к использованию при морозах до -15-10 град. С

Показатели высокотемпературной вязкости означают следующее:

* 30 — масло пригодно к использованию при жаре до +20-25 град. С* 40 масло пригодно к использованию при жаре до +35-40 град. С* 50 масло пригодно к использованию при жаре до +45-50 град. С

* 60 масло пригодно к использованию при жаре до +50 град. С и выше

Чем меньше цифра — тем «жиже» масло, чем больше цифра — тем оно более густое. Таким образом, масло 10W-30 можно использовать при температуре окружающей среды от -20-25 градусов мороза, до +20-25 градусов жары.

Расшифровка цифр API

Область применения масла классифицируется в основном по API (American Petroleum Institute)- обозначения API ставится две буквы (например, SJ или CF), первая из которых обозначает тип двигателя: S-бензиновый мотор, C-дизельный. Вторая буква конкретизирует условия применения масла — современный двигатель или старый, с турбиной или без. Если масло обозначено API SJ/CF — значит, оно подходит и для бензиновых и для дизельных моторов данной категории.

Обозначения API для бензиновых моторов:

* SC — автомобили, разработки до 1964 годов* SD — автомобили, разработки 1964-1968 годов* SE — автомобили, разработки 1969-1972 годов* SF — автомобили, разработки 1973-1988 годов* SG — автомобили, разработки 1989-1994 годов, для жестких условий эксплуатации* SH — автомобили, разработки 1995-1996 годов, для жестких условий эксплуатации* SJ — автомобили, разработки 1997-2000 годов, лучше энергосберегающие свойства* SL — автомобили, разработки 2001-2003 годов, увеличенный срок эксплуатации

* SM — автомобили разработки с 2004 года, SL+повышенная стойкость к окислению

При смене типа масла, по классификации API можно идти лишь «по возрастающей», и менять класс лишь на парочку пунктов. К примеру, вместо SH использовать SJ, обычно масло более высокого класса уже содержит необходимые присадки «предыдущего» масла. Однако, к примеру переходить с SD (для старых авто) на SL (для современных авто) не следует — масло может оказаться слишком уж агрессивным.

Обозначения API для дизельных моторов:

* CB — автомобили до 1961 г., высокое содержание серы в топливе* CC — автомобили до 1983 г., работающие в тяжелых условиях* CD — автомобили до 1990 г., много серы в топливе и тяжелые условия работы* CE — автомобили до 1990 г.

, двигатель с турбиной* CF — автомобили с 1990 г., с турбиной* CG-4 — автомобили с 1994 г., с турбиной* CH-4 — автомобили с 1998 г.

, под высокие нормы токсичности США* CI-4 — современные автомобили, с турбиной, с клапаном EGR

* CI-4 plus — аналогично предыдущему, под высокие нормы токсичности США

__________________________________________________________________________________

SAE 5W-40 — Классификация по вязкостно-температурным свойствамAPI SJ/CD — Классификация по эксплуатационным свойствамACEA A3-96; B3-96 — Европейская классификация по эксплуатационным свойствамCCMC G-5/PD2 — Европейская классификация по эксплуатационным свойствамVolkswagen 500.00 и 505.00 (11/92) — Дополнительные спецификации производителей Porsche, BMW, Mercedes-Benz 229.1

__________________________________________________________________________________

В Европе часто используется классификация масла по ACEA (Европейская ассоциация авто-производителей). Отчасти требования к качествам масла пересекаются с требованиями API, однако, они более жесткие по ряду параметров.

Масла для бензиновых и дизельных двигателей обозначаются буквосочетанием «А/В» с определенной цифрой после буквы. И чем больше эта цифра — тем выше требования к маслу: к примеру, масло с классом ACEA A3/B3 так же имеет класс API SL/CF.

Однако, используя высоконагруженные турбированные компактные моторы, европейцы вынуждены разрабатывать и специальные масла с максимальными защитными свойствами и минимальной вязкостью (дабы снизить потери на трение и улучшить экологические показатели).

К примеру, масло класса ACEA A5/B5 по ряду параметров может оказаться «круче» API SM/CI-4.

Так же существует классификация масла по ISLAC (международный комитет, созданный американцами и японцами), однако все стандарты качества ISLAC пересекаются со стандартами API.

Так, масла ISLAC класса GL-1 используются для бензиновых двигателей и соответствуют маслам API SH, масла ISLAC GL-2 используются в бензиновых двигателях и соответствуют API SJ, ну а ISLAC GL-3, как не трудно догадаться, используются в бензиновых двигателях и соответствуют API SL.

Так же для японских дизельных автомобилей может потребоваться масло спецификации JASO DX-1, которая учитывает жесткие требования к качеству моторных масел для современных экологичных высоконагруженных японских турбодизелей.

Источник: https://www.drive2.ru/b/366814/

API

Узнай первым о новых статьях в нашем блоге

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

Простейшей аналогией использования API будет процесс работы на калькуляторе для сложных вычислений. Допустим, у вас есть задача, вы можете понимать её суть, строить уравнения и графики, но не умеете совершать арифметические действия с цифрами.

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

По такому принципу работает любое API. Вам все равно, как программа получает ответ, какой путь проходит запрос внутри неё, как производятся вычисления. Вы уверены только в одном – в ответ будет выдана стандартизированная информация об успехе операции или её ошибке.

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

Плюсы:

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

Минусы:

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

Примеры API

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

VKAPI

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

Все запросы осуществляются к адресу https://api.vk.com/method/

После слэша идёт наименование используемого API-метода и передаются GET-параметры запроса. Ответ так же приходит по HTTPS в формате JSON.

TELEGRAM BOT API

Одно из самых популярных API. С его помощью осуществляется контроль ботов в мессенджере Telegram. После создания бота через @botfather и получения необходимых ключей доступа, вы можете начать взаимодействие с внутренним интерфейсом.

Запросы осуществляются по адресу https://api.telegram.org/bot0000000:token/

Где вместо bot0000000 ставится уникальный идентификатор вашего бота, а token выражает секретный ключ.

Запросы посылаются через HTTPS соединения, название метода указывается через слэш к основному адресу. Ответ приходит в формате JSON.

OPEN WEATHER MAP API

Зачастую бывает необходимо получить информацию о погоде, не задействуя сторонние виджеты и платные приложения. На помощь приходит сервис OpenWeatherMap с открытым и бесплатным API.

После регистрации и получения идентификационных данных вы можете отправлять с серверных скриптов запросы на погоду по всему миру.

В ответ на ID города ресурс возвращает максимально подробную информацию о текущей погоде и дает прогноз на ближайшее время.

Формат работа: HTTP передача по api.openweathermap.org/data/2.5/weather?id= c указанием идентификационного номера желаемого города. Ответ сервера: JSON.

Источник: https://semantica.in/blog/api.html

Что значит API

Найдено 9 значений.

По-английски По-русски
API Application Programming Interface Интерфейс прикладного программированияИнтерфейс, посредством которого приложение получает доступ к операционной системе или другим сервисам. Это набор («библиотека») стандартных процедур, программных прерываний, вызовов, форматов данных и других средств, которые должны использовать прикладные программы для реализации своих функций.
API American petroleum institute Американский нефтяной институтСША АПИ
ISAPI Internet Server Application Programming Interface Прикладной программный интерфейс к серверу интернетаИнтерфейс к серверу Интернета фирмы Microsoft, предназначенный для программного управления сервером. Поддерживается большинством ведущих производителей программных средств данного назначения. ISAPI-программы представляют собой специальный вид приложений, обрабатывающих пользовательские запросы и отображающих их вывод в виде потока HTML, который поступает непосредственно в браузер клиента. ИСАПИ
RAD Rapid Application Development Быстрая разработка приложенийНазвание методологии разработки программного обеспечения РАД
JDBC Java DataBase Connectivity Связность баз данных на языке JavaПрикладной программный интерфейс (API), который является версией ODBC, написанной на языке Java для выполнения SQL-запросов, включая установление соединений с базами данных, отсылку SQL-запросов и обработку полученных данных. Он позволяет отсылать SQL-запросы почти ко всем реляционным БД, что избавляет разработчиков программных продуктов от необходимости для каждой СУБД (Informix, Oracle и т.д.) писать отдельное приложение, поскольку каждое приложение может переноситься на различные платформы. JDBC расширяет функциональные возможности Java.
ASP Active Server Pages Активные серверные страницыТехнология создания Web-приложений, использующая объектную модель интерфейса, созданного на основе ISAPI-фильтра. ASP упростила задачи генерации HTML-страниц и позволила производить обращение к компонентам баз данных. Исходный принцип, заложенный в основу интерфейса приложения, заключается в том, что на Web-странице присутствуют фрагменты кода, который интерпретируется Web-сервером и предоставляет пользователю готовый результат выполнения выбранных фрагментов кода. Web-страница, созданная с использованием технологии ASP, имеет расширение «.asp». АСП
CAPEX capital expenditures капитальные расходы (затраты, издержки)(финансы и бухгалтерский учёт) затраты на приобретение, возведение, модернизацию и реконструкцию объектов основных средств; в бухучете обычно относятся на счет соответствующего актива, а не отражаются как расход, уменьшающий сумму прибыли данного периода капзатраты
HPV human papilloma virus вирус бородавки человекамедицина
WACC weighted average cost of capital средневзвешенная стоимость (цена) капиталаПоказывает, во сколько обходится фирме использование единицы капитала. Рассчитывается путем суммирования произведений стоимости привлечения капитала из того или иного источника на долю капитала, привлечённого из данного источника, в общем размере капитала.
Читайте также:  Толкование фразеологизма возлюби ближнего своего, как самого себя? смысл?

Знаете то, чего не знаем мы?

Мы будем очень благодарны, если вы пришлёте нам свои варианты сокращений.

Источник: http://acro.maximals.ru/?text=API

Что такое API моторного масла?

API – что это означает?

1. Определение, что такое классификация API, для чего разработана данная система?

2. Основные сокращения и их расшифровка.

Классификация масел API

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

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

Теперь подробнее

API расшифровывается, как American Petroleum Institute, что в переводе с английского означает – Американский институт нефти. Институт был создан в 20-х годах ХХ века. Основная задача данного негосударственного учреждения – разработка и контроль за соблюдением стандартов в области нефтяной промышленности.

В 1969 года американским институтом был введен стандарт, предназначенный для классификации моторных масел по их качеству и назначению.

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

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

Основные сокращения и их расшифровка API

Итак, начнем с того, что классификация API делить все масла на бензиновые и дизельные, о чем свидетельствует первая буква после заветной аббревиатуры:

  • API S_ — означает, что масло предназначено для ДВС, которые работают на бензине.
  • API C_ — показатель того, что масло предназначено для ДВС, работающих на дизеле.
  • API G_ — означает, что масло необходимо заливать в коробку передач.
  • API Т_- данные масла подходят только для двухтактных двигателей.

Далее, после того, как мы определили назначение масла, нам нужно понять какому классу оно принадлежит. Ведь если у Вас Мерседес 2017 года выпуска, Вы не можете заливать в него масло, которое также заливают в ВАЗ 2007 1998 года выпуска.

Чтобы Вам помочь, специалисты американского института нефти разработали следующую классификацию, подробнее о которой мы расскажем в данной статье.

Таким образом, следующая буква в заветном шифре означает, какому именно двигателю подходит продукт.

Бензиновые двигатели API S_

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

B – этой буквой обозначались масла для транспортных средств 1964 года выпуска и ранее, которые обладали малым количеством лошадиных сил (легковые авто). На сегодняшний день вы также не встретите продукты с данной маркировкой, так ка они устарели и не используются в современных автомобилях.

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

D – четвертая буква алфавита появилась с появлением новых моделей двигателя внутреннего сгорания в 1968 году и заливалась именно в эти автомобили. Сейчас также считается устаревшей.

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

G – 1989 год – это классика в российском автопроме (ВАЗ 2106/07/08/09 и т.д), поэтому, вполне вероятно, что у кого-то в гараже еще есть 28 летняя старушка, которая, благодаря бережному отношению хозяина еще на ходу. Так вот моторные масла отмеченные буквой G – это то, что Вам нужно. Данные масла уже обладают такими полезными свойствами, как защита двигателя от ржавчины.

H —  эта улучшенная версия моторного масла предназначена для бензинового двигателя, разработанного по технологии 1994 года выпуска. Здесь уже начали появляться такие присадки, которые более-менее защищают двигатель от износа и загрязнений + данные масла противостоят коррозии.

 J – продукт, который предназначен для всех видов транспортных средств чей ДВС был улучшен в 1996 году. В маслах данной категории появляется новое преимущество – они способствуют защите двигателя при минусовых температурах. То есть впервые в 1996 году появилось масло, которое хоть как-то могло завести двигатель в мороз.

L – 2000год, появляется первое масло, которое можно назвать экологически чистым. Таким образом, все автомобили, произведенные в 2000году и позднее, нуждаются именно в данном продукте, дабы соблюдать экологические мировые нормы. Данное масло уже можно заливать в турбированные и инжекторные авто.

M —  одно из последних и современных поколений моторных масел, которые подходят для современных автомобилей. Данная классификация существует с 2004 года и соответственно подходит для авто не старше 13 лет (на момент 2017 года).

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

Также масла данной категории полностью адаптированы к любым погодным условиям и в зависимости от вязкости могут сохранять свои характеристики как при -35, так и при +40 .

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

Дизельные двигатели API С_

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

B – этой буквой обозначались масла для транспортных средств со среднего уровня выносливостью 1949-60 года выпуска. На сегодняшний день такого вида масел на прилавках не найти. Тогда это считалось очень качественное улучшенное масло.

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

D, D+ и D-2 – данные масла считаются также продуктами прошлого века, но мы напишем о них для общего развития, чтобы вы понимали, что они предназначались для дизельных колхозных агрегатов.

Такие как комбайн, косилки, сеялки и т.д.

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

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

F-4, F-2, F— в 1990 году во всем мире начинают набирать популярность автомобили, которые способны активно передвигаться на высоких скоростях.

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

И продукт был адаптирован как для двух, так и для четырехтактных двигателей, о чем свидетельствует цифра 2 и 4.

G-4 – данный вид масел подходит как для рейсовых автобусов, так и для грузовиков и тягачей, чей двигатель был произведен по технологии 1995 года и позднее. Данного вида моторные масла гарантируют мощную защиту двигателя от всех загрязнений. Данные масла также обладают теме же характеристиками, что и масла категорий D, E и F-4.

I-4 и I-4 + —  масло, соответствующее стандартам 21 века, где начали предъявляться особые требования к экологичности отходов, а также повышенные требования к чистящим присадкам и больших температурных нагрузок.

j-4 – масла 21 века, лучше данных масел на рынке пока не существует.

Если вы видите на канистре надпись API СJ-4 – это означает, что данное смазочное вещество разработано специально для грузовиков и фур последнего поколения, год выпуска которых не ранее 2006 года.

На сегодняшний день это самое популярное масло, которое льют в свои движки дальнобойщики и водители тягачей и современной тяжелой техники.

Двухтактные двигатели API Т_

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

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

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

Трансмиссионные масла API G_

L-4 масло подходит для МКПП. Особенность масла в том, что его рекомендуют использовать при средних температурах воздуха. При температурах ниже -15  масло может замерзнуть и потерять свои свойства.

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

Вышеуказанные масла наиболее популярны в сегодняшних условиях, поэтому использовать их предшественников L-3, L-2 и L-1 можно, но только если это допускают производители вашего транспортного средства. Так как данные продукты обладают меньшим количеством присадок и не приспособлены к суровым нынешним условиям дорог.

Замена масла и ТО Mazda CX-5

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

Что такое API моторного масла?

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

Все об автомобильном масле для Хендай Крета (Hyundai Creta)

Многие интересуются, какое масло является родным, то есть оригинальным для Hyundai Creta? Вопрос довольно логичный, ведь если вы знаете, какое масло льют на производстве вашего авто, то лучше всего при дальнейшей эксплуатации будет использовать именно эту

Источник: http://oil-sales.ru/info/chto_takoe_api_motornogo_masla.html

Что такое API

Вы здесь: Главная — PHP — PHP Основы — Что такое API

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

API (application programming interface) — это интерфейс прикладного программирования. Если говорить более простым языком, то это набор различных функций, констант, классов, форматов запросов, которые можно использовать в других программах.

Можно считать, что API — это некий объект, реализацию которого мы не знаем, однако, можем его использовать.

Например, компьютер — объект, реализацию которого знают очень мало людей, однако, использовать его могут почти все, совершая какие-то действия: просмотр видео, сёрфинг по Интернету, печать текста и прочее. Как это всё работает — мало, кто знает, а вот делать это могут чуть ли не все.

Примером API является Windows API, OpenGL API, Direct3D API и так далее.

Например, не так давно я тоже столкнулся напрямую с API. Я зарегистрировался на сервисе почтовых рассылок «SmartResponder.ru» и завёл рассылку, на которую стали подписываться люди.

Читайте также:  Что значит имото в аниме? как понять имото-чан? смысл

Задача была следующая: в течение суток после подписки человек может приобрести со скидкой мой платный видеокурс. Так как вся информация о подписчиках хранится на сервере «SmartResponder.

ru«, то обычный доступ (например, через БД) к этим данным я не имел, а реализовывать это было нужно. Благо, у «SmartResponder.ru» есть свой собственный API, которым я и воспользовался.

Я нашёл в их API формат запроса, чтобы в результате вытащить дату подписки. Далее через cURL я отправил соответствующий запрос и получил искомую дату подписки для конкретного e-mail адреса. Далее стандартная обработка и вывод результата.

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

Предыдущая статья Следующая статья

Копирование материалов разрешается только с указанием автора (Михаил Русаков) и индексируемой прямой ссылкой на сайт (http://myrusakov.ru)!

Добавляйтесь ко мне в друзья ВКонтакте: http://vk.com/myrusakov.
Если Вы хотите дать оценку мне и моей работе, то напишите её в моей группе: http://vk.com/rusakovmy.

Если Вы не хотите пропустить новые материалы на сайте,
то Вы можете подписаться на обновления: Подписаться на обновления

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

Если Вам понравился сайт, то разместите ссылку на него (у себя на сайте, на форуме, в контакте):

  1. Кнопка:

    Она выглядит вот так:<\p>

  2. Текстовая ссылка:

    Она выглядит вот так: Как создать свой сайт

  3. BB-код ссылки для форумов (например, можете поставить её в подписи):

Источник: https://MyRusakov.ru/php-api.html

Руководство по построению HTTP API

Данное руководство содержит рекомендации по проектированию HTTP API, которые были почерпнуты из работы API облачной платформы Heroku, кроме того, оно также содержит информацию о новом функционале и внутреннем API в Heroku.

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

При прочтении данной статьи подразумевается, что вы знакомы с основными принципами HTTP и JSON.

Основы

Принцип разделения ответственности

При проектировании старайтесь сохранять простоту системы, разделяя ответственность между различными частями цикла «запрос-ответ».  При этом простота принимаемых решений позволит концентироваться на решении все более сложных задач. Запросы и ответы выполняются для получения доступа к определенному ресурсу или набору ресурсов.

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

Требуйте использования защищенных соединений

Для получения данных при помощи API используйте только защищенные соединения с TLS.
Лучше решением было бы отклонять все запросы, не использующие TLS, а именно запросы по http или на 80-ый порт, во избежание небезопасного обмена данными. В случаях, когда это невозможно, отдавайте ответ 403 Forbidden.

Перенаправления не приветствуются, поскольку они допускают некорректное поведение клиента, не предоставляя при этом никаких четких объяснений. Клиенты, которые полагаются на редиректы, удваивают таким образом трафик сервера и использование TLS в этом случае бесполезно, поскольку важные данные оказываются незащищенными при первом вызове.

Требуйте наличие версии в заголовке Accept

Наличие нескольких версий и переходы между ними может быть одним из самых сложных аспектов проектирования и использования API. Поэтому лучше заранее учесть этот момент.

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

Лучше всего – добавить версию в заголовок вместе с другими метаданными, используя заголовок Accept с пользовательским типом содержимого:

Accept: application/vnd.heroku+json; version=3

Используйте заголовок ETags для кеширования

Включайте заголовок ETags во все запросы, определяя при этом версию возвращаемого ресурса. Это позволит пользователям кэшировать ресурсы и реализовывать условные запросы при помощи использования заголовка If-None-Match, который поможет определить, нужно обновлять кэш или нет.

Используйте Request-ID для интроспекции

Включайте заголовок Request-Id, содержащий в себе UUID значение, в каждый ответ сервера. Регистрируя эти значения на клиенте, сервере или другом сервисе, вы получаете возможность отлаживать и диагностировать проблемы, связанные с запросами.

Разделяйте большие ответы сервера на несколько небольших при помощи заголовка Range

Большие ответы необходимо разбивать на более мелкие, используя заголовок Range. Для получения более детальной информации о заголовках запросов/ответов, кодах состояний и ограничениях изучите Обсуждение использования заголовка Range в API платформы Heroku .

Запросы

Возвращайте соответствующие  коды состояний

Возвращайте соотвествующий код состояния HTTP в каждом ответе. Успешные ответы должны содержать такие коды состояний:

  • 200 – GET запрос завершился успешно, синхронный DELETE или PATCH запрос завершился успешно или синхронный PUT запрос обновил существующий ресурс.
  • 201 – Синхронный POST запрос завершился, синхронный PUT запрос создал новый ресурс.
  • 202 – Принят POST, PUT, DELETE или PATCH запрос, который будет обработан асинхронно.
  • 206 – GET запрос завершился успешно, но будет возвращен частичный ответ (см. раздел про заголовок Range).

Обратите внимание на использование кодов состояния ошибок авторизации и аутентификации:

  • 401 Unauthorized – запрос завершился с ошибкой, поскольку пользователь не прошел аутентификацию.
  • 403 Forbidden – запрос завершился с ошибкой, так как пользователь не авторизовался для получения доступа к определенному ресурсу.

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

  • 422 Unprocessable Entity – Ваш запрос был распознан, но содержит неверные параметры.
  • 429 Too Many Requests – Превышен лимит запросов, попробуйте позже.
  • 500 Internal Server Error – Проблема на стороне сервера, проверьте состояние сайта и/или сообщите о проблеме.

Для получения более подробной информации о кодах состояния HTTP изучите спецификацию.

По возможности, предоставляйте полные версии ресурсов

Возвращайте пользователям вашего API полное представление ресурса (то есть объект со всеми атрибутами) во всех ответах, где это возможно. Всегда предоставляйте полную версию ресурса в ответах на запросы с кодами состояния 200 и 201, включая PUT, PATCH и DELETE запросы.

$ curl -X DELETE https://service.com/apps/1f9b/domains/0fd4 HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{ «created_at»: «2012-01-01T12:00:00Z», «hostname»: «subdomain.example.com», «id»: «01234567-89ab-cdef-0123-456789abcdef», «updated_at»: «2012-01-01T12:00:00Z»
}

Ответы на запросы с кодом состояния 202 не должны содержать все поля объекта

$ curl -X DELETE https://service.com/apps/1f9b/dynos/05bd HTTP/1.1 202 Accepted
Content-Type: application/json;charset=utf-8

{}

Ваш API должен принимать сериализованный JSON в теле запроса

Ваш API должен предусматривать возможность передачи сереализованного JSON в теле PUT/PATCH/POST запросов вместо, либо в дополнение к передаваемым данным формы. Таким образом создается симметрия в JSON-ответах:

$ curl -X POST https://service.com/apps -H «Content-Type: application/json» -d '{«name»: «demoapp»}' { «id»: «01234567-89ab-cdef-0123-456789abcdef», «name»: «demoapp», «owner»: { «email»: «username@example.com», «id»: «01234567-89ab-cdef-0123-456789abcdef» }, …
}

Будьте последовательны при конструировании пути к ресурсу

Названия ресурсов

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

Действия

Старайтесь проектировать такие конечные url, которые не требуют дополнительных действий для отдельных ресурсов. В случаях, когда это необходимо, добавляйте в общий путь компонент «action» для того, чтобы четко определить эти действия:

/resources/:resource/actions/:action

Например:

/runs/{run_id}/actions/stop

Используйте названия компонентов пути и атрибутов в нижнем регистре

Для названий компонентов пути к ресурсу используйте нижний регистр и разделяйте их при помощи дефиса.

service-api.com/users
service-api.com/app-setups

Названия атрибутов лучше писать в нижнем регистре, а в качестве разделителя лучше использовать нижнее подчеркивание – таким образом названия полей можно писать без скобок в Javascript:

service_class: «first»

Ваш API должен поддерживать доступ к ресурсу не только по его id

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

$ curl https://service.com/apps/{app_id_or_name}
$ curl https://service.com/apps/97addcf0-c182
$ curl https://service.com/apps/www-prod

Сведите к минимуму  количество вложений в пути для доступа к ресурсу

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

/orgs/{org_id}/apps/{app_id}/dynos/{dyno_id}

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

/orgs/{org_id}
/orgs/{org_id}/apps
/apps/{app_id}
/apps/{app_id}/dynos
/dynos/{dyno_id}

Ответы

Предоставляйте UUID запрашиваемых ресурсов

У каждого ресурса по умолчанию должен быть атрибут id. В качестве значений идентификатора ресурса старайтесь всегда использовать UUID. Не используйте идентификаторы, которые не будут уникальными в масштабе вашего сервиса, особенно автоинкрементные идентификаторы.
UUID ресурса выводите в формате 8-4-4-4-12:

«id»: «01234567-89ab-cdef-0123-456789abcdef»

Предоставляйте информацию о дате создания и изменения ресурса

По умолчанию ресурс должен хранить информацию о дате его создания created_at и обновления updated_at.

{ // … «created_at»: «2012-01-01T12:00:00Z», «updated_at»: «2012-01-01T13:00:00Z», // …
}

Временные величины должны быть форматированы согласно ISO8601

Принимайте и возвращайте временные данные только в UTC, а выводите в формате ISO8601:

«finished_at»: «2012-01-01T12:00:00Z»

Отношения с внешними сущностями должны быть вынесены во вложенный объект

Внешние отношения должны быть сериализованы как вложенный объект:

«name»: «service-production», «owner»: { «id»: «5d8201b0…» }, // …

А не как поле объекта:

{ «name»: «service-production», «owner_id»: «5d8201b0…», // …
}

Такой подход позволяет добавить больше информации о связанном объекте без необходимости менять структуру ответа:

{ «name»: «service-production», «owner»: { «id»: «5d8201b0…», «name»: «Alice», «email»: «alice@heroku.com» }, // …
}

Создавайте структурированные ответы в случае возникновения ошибок

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

HTTP/1.1 429 Too Many Requests
{ «id»: «rate_limit», «message»: «Account reached its API rate limit.», «url»: «https://docs.service.com/rate-limits»
}

Показывайте ограничение по количеству запросов

Ограничение по количеству запросов вводится для поддержания работоспособности системы и возможности качественного обслуживания других клиентов. Для расчета ограничений на количество запросов можно использовать алгоритм текущего ведра. Возвращайте оставшееся количество запросов для каждого запроса в заголовке ответа RateLimit-Remaining.

JSON во всех ответах должен быть минимизирован

Лишний пробел увеличивает размер ответа и многие Javascript клиенты для удобочитаемости автоматически отформатируют JSON. Поэтому лучше минимизировать JSON ответы:

{«beta»:false,»email»:»alice@heroku.com»,»id»:»01234567-89ab-cdef-0123-456789abcdef»,»last_login»:»2012-01-01T12:00:00Z»,»created_at»:»2012-01-01T12:00:00Z»,»updated_at»:»2012-01-01T12:00:00Z»}

вместо

{ «beta»: false, «email»: «alice@heroku.com», «id»: «01234567-89ab-cdef-0123-456789abcdef», «last_login»: «2012-01-01T12:00:00Z», «created_at»: «2012-01-01T12:00:00Z», «updated_at»: «2012-01-01T12:00:00Z»
}

Вы можете опционально добавить возможность получать более развернутый ответ, указывая дополнительный параметр (например, ?pretty=true) или задавая значения для заголовка Accept (Accept: application/vnd.heroku+json; version=3; indent=4;).

Артефакты

Предоставляйте удобную для обработки JSON-схему

Для точного описания вашего API предоставляйте JSON-схему. Для управления схемой используйте prmd, также удостоверьтесь в том, что она проходит валидацию при помощи команды prmd verify.

Предоставляйте удобочитаемую документацию

Для того, чтобы разработчики разбирались в принципах работы вашего API, предоставьте им удобную документацию. Если вы создали JSON-схему, используя prmd, как описано выше, вы можете легко сгенерировать Markdown документацию для всех конечных url, используя команду prmd doc.

Вдобавок к описанию конечных url, предоставьте обзор API, включая туда следующую информацию:

  • процесс аутентификации — получение и использование пользовательского токена;
  • стабильность API и его версию, а также информацию о том, как выбрать нужную версию API;
  • общие заголовки запросов и ответов;
  • формат выдачи ошибки;
  • примеры использования API с клиентами на разных языках;

Предоставляйте примеры запросов, которые можно протестировать

Предоставляйте примеры запросов, которые пользователи могут протестировать. Для тестирования этих запросов пользователь должен выполнить минимум действий:

$ export TOKEN=… # acquire from dashboard
$ curl -is https://$TOKEN@service.com/users

Если вы используете prmd для создания документации, то такие примеры будут сгенерированы автоматически для каждого конечного url.

Опишите стабильность вашего API

Вы можете описать степень стабильности вашего API или отдельных конечных url при помощи установки флагов prototype/development/production.

Для получения дополнительной информации, вы можете изучить документ Политика совместимости Heroku API.

Как только вы объявили ваш API готовым к релизу и стабильным, не стоит совершать модификаций, которые нарушают обратную совместимость внутри этой версии. Для внесения таких изменений создайте новою ветвь API с новым индексом версии.

Перевод статьи «HTTP API Design Guide»

Источник: https://tproger.ru/translations/http-api-design-guide/

Ссылка на основную публикацию