Что такое API | 2DOMAINS.RU ✔️

Помощь

0

Регистрация

Вход

• Домены

• Хостинг

• Сайты

• Личный кабинет

• VPS и серверы

• SSL-сертификаты

• Общие вопросы

  • Полезная информация

  • Просто о сложном

• Что такое API сайта или приложения
• Для чего нужен API
• Плюсы API
• Как работать с API
• REST API: что такое и как работает
• Что такое SOAP API
• REST API и SOAP API — в чем различия
• Что такое Web API

В этой статье мы расскажем:

• что такое API;
• как пользоваться API;
• про REST, SOAP и Web API.

Что такое API сайта или приложения

API (Application Programming Interface) — это набор функций, методов и правил, в которых описан порядок взаимодействия одного сервиса (приложения, сайта, модуля) с другим. 

Открытый доступ к API: что это

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

Для чего нужен API

1. Подключение платежной системы. Допустим, на сайте необходимо добавить возможность оплачивать покупки онлайн. Разработчик сайта может сам написать форму для оплаты, но использование такой формы может быть небезопасным, и ее создание займет много времени. Проще, безопаснее и дешевле внедрить через API стороннюю кассу и принимать оплату через нее. 
2. Настройка кнопок авторизации. Авторизация на сайте или в приложении через ВКонтакте, Google, Apple ID подключается по API.
3. Подключение навигационных карт. Можно добавить карту с местоположением офиса компании или магазина и возможностью быстро выстроить маршрут к этой точке.
4. Настройка отображения погоды. Как это работает: пользователь сервиса запрашивает погоду в конкретном регионе, запрос передаётся на метеостанцию, а затем пользователю возвращается ответ. 

Плюсы API

1. Безопасность. Функции, которые нужно защитить, можно выносить в отдельные приложения. За счет этого вероятность неправильного использования функционала другими приложениями станет ниже. 
2. Подключение по API помогает связать между собой различные сервисы. Например, интернет-магазин и платежную систему. 
3. Можно использовать готовые инструменты. Допустим, если на сайте нужно указывать адрес, то можно подключить уже готовый инструмент, подсказывающий его, а не вводить самому.  
4. Экономия времени и денег. На разработку инструмента с нуля уйдет много времени, что может дорого обойтись заказчику. Поэтому проще внедрить уже существующий функционал.

Как работать с API

API можно вызвать двумя способами:

• напрямую,
• косвенно. 

API вызывается напрямую:

• если сервис вызвал функцию внутри себя,
• если сервис вызвал функцию стороннего сервиса,
• при помощи ручного тестирования,
• при помощи автоматического тестирования.

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

Про стандарты написания API расскажем ниже. 

REST API: что такое и как работает

REST API — это набор правил, по которым сайты и приложения взаимодействуют с сервером. У REST API есть второе название — RESTful.

В этой системе существует 7 принципов, по которым пишется код:

1. Client-Server — четкое разделение клиента и сервера. Код сбора запросов обрабатывается на стороне клиента (пользовательского интерфейса), а код, обеспечивающий доступ к данным, — на стороне сервера. 
2. Casheable — кэширование. В запросе к серверу должно быть указано, нужно ли кэшировать данные. Если данные кэшируются, клиент сможет запросить данные из кэша. 
3. Stateless — отсутствие сохранения состояния. Производимые между клиентом и сервером операции не должны сохранять состояние. Запросы от клиента должны включать в себя лишь ту информацию, которая требуется, чтобы получить данные от сервера. 
4. Layered System — многоуровневая система. В REST API архитектура может состоять из нескольких серверов, расположенных на разных уровнях. При этом сервер может взаимодействовать лишь с ближайшими уровнями.
5. Code on Demand — код предоставляется по запросу. В случае необходимости сервер может отправить код клиенту (к примеру, код скрипта).
6. Starting with the Null Style — начало с нулевого стиля. Клиенту известна лишь одна точка входа на сервер.
7. Uniform Interface — единый интерфейс. Данные необходимо запрашивать с одного URL-адерса при помощи стандартных протоколов (обычно HTTP).

Для взаимодействия между приложениями RESTful API-соединение обычно использует протокол HTTP. Чтобы запрашиваемый ресурс выполнил нужное действие, используются различные виды обращений, называемые HTTP-методами. Различают 4 HTTP-метода:

• GET — возвращает данные с сервера, 
• POST — помогает добавить данные,
• DELETE — используется для удаления данных, 
• PUT — позволяет редактировать данные. 

Передача данных по API

Что такое SOAP API

SOAP (простой протокол доступа к объектам) — это протокол обмена сообщениями, благодаря которому приложения обмениваются данными друг с другом и с клиентами.
SOAP API — это веб-сервис, который работает по протоколу SOAP. С его помощью клиенты обмениваются данными с сервером. Он поддерживает протоколы HTTP, FTP, HTTPS, SMTP.

SOAP-сообщение включает в себя несколько элементов:

• Envelope (конверт) — элемент, указывающий на начало и конец SOAP-сообщения;
• Header (заголовок) — необязательный элемент, определяет дополнительные требования к сообщению (к примеру, аутентификацию). Заголовок может включать следующие элементы:

    — mustUnderstand,

    — encodingStyle,

    — role,

    — relay,

    — actor.

• Body (тело) — элемент, в котором хранится запрос, либо ответ сервера;
• Fault (ошибка) — необязательный элемент, выводит данные об ошибках, возникших во время запроса или ответа API. Состоит из следующих элементов:

    — code,

    — reason,

    — node,

    — role,

    — detail.

Интеграция по API: что это

REST API и SOAP API — в чем различия

1. SOAP — это стандартизированный протокол обмена сообщениями. У REST нет общего стандарта, это архитектурный стиль.
2. REST ориентирован на использование транспортного протокола HTTP, а SOAP может использовать и другие протоколы (FTP, SMTP).
3. В SOAP запросы и ответы отправляются в формате XML. В REST нет ограничений по формату: это может быть JSON, XML или какой-либо другой формат. Обычно для REST используют JSON.

Что такое Web API

Web API — это программный интерфейс, его используют только для веб-программирования. 

Web API включает в себя набор HTTP-запросов и определяет структуру HTTP-ответов. Ответ выражается в JSON или XML-формате. Понятие “Web API” часто сравнивают с понятием “Web-службы”, но между ними есть отличия:

• Web-службы всегда являются API-интерфейсами, но API-интерфейсы — это не всегда Web-службы,
• В Web API может использоваться любой стиль связи,
• Web-службы — это набор протоколов и стандартов, который используется для обмена данными между приложениями. Web API – это программный интерфейс, при помощи которого веб-приложения могут взаимодействовать между собой.
  
   

Популярные статьи

• Как указать (изменить) DNS-серверы для домена

• Я зарегистрировал домен, что дальше

• Как добавить запись типа A, AAAA, CNAME, MX, TXT, SRV для своего домена

• Что такое редирект: виды и возможности настройки

• Как создать почту со своим доменом

Что такое api и как работает

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

А теперь по порядку.

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

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

Как арбитражнику поможет API

1. Передавать лиды в партнёрку:
   1. Со скачанных лендов;
   2. Со своих уникальных лендов;
2. Автоматизировать процесс создания рекламных кампаний и покупки трафика

Сегодня поговорим о первом.

Как передавать лиды в AdCombo по API

Давайте по порядку:

1. Скачать лендинг. Любой, кто зарегистрирован в AdCombo, может скачать ленд из интерфейса оффера
2. Распаковать архив с лендингом на хостинг
3. Привязать домен к ленду, прописав А\CNAME запись в регистраторе.  

Готово! Можно лить. 

Понимаем, что у новичков могут возникнуть вопросы а-ля “Неужели всё так просто?” 

Да, это действительно несложно. Всё дело в том, что при скачивании лендинга вместе с ним подтягиваются и остальные данные, такие как: 

• ключ API;
• subid;
• пиксель Facebook и TikTok.

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

Добавляем пиксель в Success page

В ПП переходим во вкладку «Offers«, выбираем оффер и открываем вкладку «Postback/Pixel«

Вставляем пиксель-код в поле «Pixelcode for leads on success«. Этот пиксель отобразится на странице благодарности (success page) после того, как посетитель совершит заказ.

После добавления пиксель-кода жмём кнопку ‘Save‘.

Теперь в скачанном лендинге этого оффера будет встроен ваш пиксель-код. Сам пиксель записывается в файл config.php в параметр ‘PIXEL_CODE‘. При необходимости можете поправить код вручную, или самостоятельно вставить его в файл.

Кстати, мониторить наличие пикселя на странице будет удобно с помощью расширений.

• Для ФБ: Facebook Pixel Helper
• Для ТТ: TikTok пиксельный помощник

По сути, в таком случае API уже настроено за тебя, и само “попросит” нас создать заказ в системе и зачислить тебе деньги на счёт. 

Если твои знания в кодинге чуть меньше, чем “hello world”, то этой инструкции должно быть достаточно. В этом случае не рекомендуем вносить изменения в код ленда. Работает — не трогай!

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

Структура лендинга

Структура лендов AdCombo чаще всего одинаковая:

• В папке “content” находится код лендинга и его визуальная часть: стили, изображения и скрипты;
• В папке “vendor” хранятся различные библиотеки, которые поддерживают функционал лендинга. Среди прочего, здесь находятся библиотеки для определения гео по IP-адресу, типа устройства юзера (desktop/mobile).
• Файл index.php импортирует .php библиотеки, помогает определить тип устройства пользователя и в зависимости от этого отображает мобильную или десктопную версию.
• В config.php находятся динамические параметры лендинга. Именно этот файл при скачивании ленда  заполняется персональным  api_key, ссылкой, на которую будет отправляться запрос в момент создания лида, кодом пикселя ретаргетинга (если был указан в интерфейсе оффера) и subid. 

Так вот, если ты  не добавил subid или код пикселя до скачивания оффера, то сделать это можно в config.php

Также config.php содержит кастомные параметры, которые будут автоматически добавлены к передаваемому по API массиву в виде ‘ключ’ => ‘значение’. Сюда можно воткнуть, например, utm метки, субаккаунты или любые другие кастомные параметры.

ВАЖНО: параметры из config.php ПЕРЕЗАПИСЫВАЮТ данные, полученные непосредственно из URL лендинг-страницы. Чтобы передавать данные из ссылки, значения аргументов надо оставлять пустыми (или вообще удалить строки).

• Order.php — этот файл импортирует страницу Success или  “Страница спасибо”.  В момент, когда происходит успешная отправка данных в форму. HTML разметка (типовая для всех товарных лендов AdCombo) содержится в этом файле. Соответственно, редактировать success-page — тоже здесь.
• Orderlog.php — файл собирает сгенерированные на лендинге заказы ровно в том виде, как они отправляются по API, а также response статусы по каждому лиду.

Как залить ленд на хостинг

Давайте разберёмся на примере beget, как залить ленд на хостинг. Мы не будем писать, какой хостинг и тариф выбрать, как регистрироваться. В этом материале сконцентрируемся именно на заливе ленда на хост.

Итак, заходим на хост и открываем файловый менеджер.

На хостинге уже лежит папка с названием сайта, одноимённым с доменом. Нужно зайти в неё. Внутри этой папки необходимо создать ещё одну папку public_html, если такой нет. В неё мы распакуем архив. 

Если в папке уже лежит какой-то контент, смело удаляем. Далее жмём ПКМ по свободному пространству и далее “Загрузить файлы”. Выбираем архив. Грузим. После этого снова жмём ПКМ, но уже по загруженному архиву и кнопку “Распаковать здесь”. 

Готово! 

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

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

Как видим, ленд по нужному адресу прогрузился. Оставляем тестовый заказ…

иии

Оно работает! Поздравляем, теперь ты освоил базовый курс программирования, можешь бросать арбитраж и устраиваться на работу джуниор фронтенд разработчиком за 100к+  сможешь залить ленд на хостинг самостоятельно! Как мы и предупреждали, это будет просто 🙂

Если вдруг эту статью читают матёрые арбитражники или ребята с неплохим знанием языков программирования, то в базе знаний AdCombo есть исчерпывающая страница со всеми необходимыми параметрами по работе с API. Почитать можно тут: confluence.adcombo.com

Как дать своё имя сайту

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

Для хостинга сайт это папка, которая хранится у него на сервере. Чтобы при наборе домена в окне браузера открывался нужный сайт (выполнялись файлы из нужной папки), нужно соединить этот домен с сайтом. 

Тут есть 2 кейса:

1. Вы купили домен и хостинг на одном и том же сервисе. Тогда, скорее всего, автоматом подцепит домен и ничего больше делать с ним будет не нужно;
2. Домен и хостинг куплены на разных сервисах. В этом случае нужно привязать домен из сервиса к папке с сайтом на хостинге. Делается это через настройки DNS. Тут тоже есть 2 варианта:
   1. Прописать NS записи хостинга в настройках домена на сайте регистратора. Простым языком: сказать сервису, где купили домен, что теперь DNS записями нашего домена мы будем управлять с сайта хостинга.
   2. Прописать CNAME запись хостинга в настройках DNS домена на сайте регистратора. Так мы просто говорим регистратору, что вот по этому имени домена будет отображаться контент с вот этого хостинга.

Может показаться трудноватым, но это, как говорится, БАЗА. Это мы ещё не погружались в понятия DNS, NS и т.д. (а может мы просто не знаем😁). 

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

Итак, у нас есть папка с сайтом на beget и тестовый домен domain-for-api-article.icu/, купленный на ahnames.

В главном меню на хосте заходим в раздел Домены и поддомены.

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

Если вы выбрали другую, то позже всё равно можно прикрепить домен в настройках сайта. Теперь возвращаемся в главное меню и переходим в раздел DNS. Копируем адрес А записи.

После этого переходим на сайт регистратора домена, также заходим в раздел DNS и создаём CNAME запись типа А и именем поддомена www. 

Сохраняем и ждём 10 минут, пока обновится кэш. 

После чего переходим по нашему адресу http://www.domain-for-api-article.icu/ (это тестовый домен, который мы использовали для статьи. Вам нужно переходить по адресу своего домена). И видим, что там отображается то, что нужно. Для большей уверенности можем оставить тест лид и проверить, что он отобразился в стате или графе orders. Всё готово, теперь ты настоящий хацкер и можешь лить трафик по API.

Итак, сегодня мы узнали что такое API, как и главное зачем лить по API, научились скачивать и загружать ленд на хостинг и под конец изучили, как подцепить своё доменное имя для ленда. Все эти вещи должен знать каждый уважающий себя арбитражник. Как мы уже писали: ЭТО БАЗА. Без понимания устройства механизмов партнёрского маркетинга в нём невозможно преуспеть. 

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

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

Настройка пользовательских доменных имен для REST API

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

После развертывания вашего API вы (и ваши клиенты) можете вызывать API
используя базовый URL-адрес по умолчанию в следующем формате:

  https://  API-id  .execute-api.  регион  .amazonaws.com/  stage   

где API-id генерируется шлюзом API, регион (регион AWS) указан вами
при создании API, а stage указывается вами при развертывании
API.

Часть имени хоста URL-адреса (т. е.
API-идентификатор .execute-API. регион .amazonaws.com )
относится к конечной точке API. Конечная точка API по умолчанию
может быть трудным для запоминания и неудобным для пользователя.

С собственными доменными именами вы можете настроить имя хоста вашего API и выбрать базовый путь (для
например, myservice ), чтобы сопоставить альтернативный URL с вашим API. Например, более
удобный для пользователя базовый URL API может стать следующим:

 https://api.example.com/myservice 

URL-адрес совпадает с личным доменом (например, https://api.example.com ). В
в этом случае собственное доменное имя не может поддерживать более одного API.

Примечание

Региональный пользовательский домен может быть связан с REST API
и HTTP-API. Вы можете использовать API-интерфейсы шлюза API версии 2 для создания региональных имен пользовательских доменов и управления ими.
для REST API.

Имена собственных доменов не поддерживаются для частных API.

Вы можете выбрать минимальную версию TLS, которую поддерживает ваш REST API. Для REST API вы можете
выберите TLS 1. 2 или TLS 1.0.

Зарегистрируйте доменное имя

У вас должно быть зарегистрированное доменное имя в Интернете, чтобы настроить собственные доменные имена для
ваши API. При необходимости вы можете зарегистрировать интернет-домен с помощью Amazon Route 53 или стороннего регистратора доменов по вашему выбору. API
пользовательское доменное имя может быть именем поддомена или корневого домена (также известного как «зона
apex») зарегистрированного интернет-домена.

После создания личного доменного имени в API Gateway необходимо создать или обновить свой DNS
запись ресурса поставщика для сопоставления с вашей конечной точкой API. Без такого сопоставления запросы API, привязанные к пользовательскому доменному имени, не могут достигать
Шлюз API.

Примечание

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

Личный домен, оптимизированный для периферийных устройств
имена

При развертывании API, оптимизированного для периферии, API Gateway настраивает дистрибутив Amazon CloudFront и DNS
запись для сопоставления имени домена API с именем домена распространения CloudFront. Запросы к API
затем перенаправляются на шлюз API через сопоставленную раздачу CloudFront.

Когда вы создаете собственное доменное имя для API, оптимизированного для периферии, API Gateway настраивает CloudFront
распределение. Но вы должны настроить запись DNS, чтобы сопоставить имя личного домена с именем CloudFront.
доменное имя дистрибутива. Это сопоставление предназначено для запросов API, которые привязаны к имени пользовательского домена, на который необходимо перенаправить
Шлюз API через сопоставленную раздачу CloudFront. Также необходимо предоставить сертификат для
пользовательское доменное имя.

Примечание

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

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

 {
    «Версия»: «2012-10-17»,
    "Заявление": [
         {
            "Sid": "AllowCloudFrontUpdateDistribution",
            «Эффект»: «Разрешить»,
            "Действие": [
                "облачный фронт:обновлениедистрибутив"
            ],
            "Ресурс": [
                "*"
            ]
        }
    ]
} 

Шлюз API поддерживает пользовательские доменные имена, оптимизированные для периферийных устройств, используя указание имени сервера.
(SNI) в дистрибутиве CloudFront. Дополнительные сведения об использовании имен собственных доменов в CloudFront см.
распространения, включая требуемый формат сертификата и максимальный размер
длина ключа сертификата, см.
Использование альтернативных доменных имен и HTTPS в
Руководство разработчика Amazon CloudFront .

Чтобы настроить собственное доменное имя в качестве имени хоста API, вы, как владелец API, должны
предоставить сертификат SSL/TLS для личного доменного имени.

Чтобы предоставить сертификат для собственного доменного имени, оптимизированного для периферии, вы можете запросить AWS Certificate Manager (ACM) для создания нового сертификата в ACM или
импортировать в ACM документ, выпущенный сторонним центром сертификации в
сша-восток-1 Регион (Восток США (Северная Вирджиния)).

Региональные пользовательские доменные имена

При создании личного доменного имени для регионального API шлюз API создает региональный
доменное имя для API. Вы должны настроить запись DNS для сопоставления личного доменного имени с
Региональное доменное имя. Также необходимо предоставить сертификат для личного домена.
имя.

Индивидуальные доменные имена с подстановочными знаками

С помощью настраиваемых имен доменных имен с подстановочными знаками вы можете поддерживать почти бесконечное количество доменных имен без превышения квоты по умолчанию. За
Например, вы можете дать каждому из ваших клиентов собственное доменное имя, имя клиента .api.example.com .

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

Например, имя пользовательского домена с подстановочным знаком *.example.com приводит к
поддомены, такие как a.example.com , b.example.com и
c.example.com , все из которых направляются в один и тот же домен.

Индивидуальные доменные имена с подстановочными знаками поддерживают конфигурации, отличные от стандартных API Gateway.
собственные доменные имена. Например, в одной учетной записи AWS вы можете настроить
*.example.com и a.example.com для поведения
иначе.

Вы можете использовать $context.domainName и
$context.domainPrefix переменные контекста для определения имени домена
который клиент использовал для вызова вашего API. Дополнительные сведения о переменных контекста см. в разделе Шаблон сопоставления шлюза API и доступ к нему.
ссылка на переменную регистрации.

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

Примечание

Вы не можете создать имя личного домена с подстановочным знаком, если другая учетная запись AWS
создал собственное доменное имя, которое конфликтует с подстановочным именем личного домена.
Например, если учетная запись A создала a.example.com , то учетная запись B
не удается создать подстановочное имя пользовательского домена *. example.com .

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

Сертификаты для личного домена
имена

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

Чтобы импортировать сертификат SSL/TLS, необходимо предоставить сертификат SSL/TLS в формате PEM.
body, его закрытый ключ и цепочка сертификатов для пользовательского доменного имени. Каждый
сертификат, хранящийся в ACM, идентифицируется его ARN. Использование сертификата, управляемого AWS
для доменного имени вы просто ссылаетесь на его ARN.

ACM упрощает настройку и использование собственного доменного имени для API. Вы создаете
сертификат для данного доменного имени (или импортировать сертификат), настроить доменное имя в
Шлюз API с ARN сертификата, предоставленного ACM, и сопоставьте базовый путь под
пользовательское доменное имя на развернутую стадию API. С сертификатами, выпущенными ACM, вы
не нужно беспокоиться о раскрытии каких-либо конфиденциальных сведений о сертификате, таких как частный
ключ.

Темы

• Подготовка сертификатов в
  AWS Certificate Manager
• Выбор минимальной версии TLS для
  личный домен в API Gateway
• Создание оптимизированного для периферии
  пользовательское доменное имя
• Настройка региональной пользовательской
  доменное имя в шлюзе API
• Миграция пользовательского доменного имени
  к другой конечной точке API
• Работа с сопоставлениями API для REST API
• Отключение конечной точки по умолчанию для REST API
• Настройка пользовательских проверок работоспособности для аварийного переключения DNS

Javascript отключен или недоступен в вашем браузере.

Чтобы использовать документацию Amazon Web Services, должен быть включен Javascript. Инструкции см. на страницах справки вашего браузера.

Работа с сопоставлениями API для REST API

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

Сопоставление API указывает API, этап и, возможно, путь для использования для сопоставления. Например, вы
может сопоставить производственную стадию API с https://api.example.com/orders .

Вы можете сопоставить этапы API HTTP и REST с одним и тем же именем пользовательского домена.

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

Маршрутизация запросов API

Вы можете настроить сопоставления API с несколькими уровнями, например заказов/v1/элементов и
заказов/v2/предметов .

Примечание

Чтобы настроить сопоставления API с несколькими уровнями, имя личного домена должно быть региональным и использовать безопасность TLS 1.2.
политика.

Шлюз API направляет запросы к сопоставлению API с самым длинным совпадающим путем. Шлюз API учитывает только пути
настроен для сопоставлений API, а не для маршрутов API, чтобы выбрать API для вызова. Если ни один путь не соответствует запросу,
Шлюз API отправляет запрос к API, который вы сопоставили с пустым путем (нет) .

Например, рассмотрим собственное доменное имя https://api.example.com со следующим API
сопоставления:

1. (нет) сопоставлен с API 1.

2. заказов/v1/элементов сопоставлены с API 2.

3. заказов/v2/элементов сопоставлены с API 3.

4. заказов/v2/элементов/категорий сопоставлены с API 4.

Ограничения

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

• Сопоставления API

  должны содержать только буквы, цифры и следующие символы:
  $-_.+!*'()/ .

• Максимальная длина пути в сопоставлении API составляет 300 символов.

• С помощью политики безопасности TLS 1.2 можно сопоставить API-интерфейсы HTTP только с региональным именем пользовательского домена.

• Вы не можете сопоставлять API-интерфейсы WebSocket с тем же именем пользовательского домена, что и HTTP-API или REST API.

Создание сопоставления API

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

Например, шаблоны модели бессерверных приложений AWS, которые создают все ресурсы, см.

This entry was posted in Популярное