Что такое ключ API? — CodeRoad
В наши дни я вижу это слово почти в каждом кросс-сервисном приложении.
Что такое ключ API и как он используется?
Кроме того, в чем разница между открытым и закрытым ключами API.
api security terminology api-keyПоделиться Источник OrangeRind 21 сентября 2009 в 06:14
6 ответов
- Firebase-что такое ключ API
В Firebase, когда мы регистрируемся, он дает нам ключ API для каждого firebase Url. Но где он используется в потребляющем приложении? fireBase API не предоставляет никаких средств для поставки ключа API. Безопасность : Что мешает кому-либо идти вперед и записывать любой объект в данный firebase…
- Что такое ключ Fabric API?
Как мы создаем наше приложение в dev.twitter.
111
Для чего используется ключ «exactly» API, во многом зависит от того, кто его выдает и для каких служб он используется. По большому счету, однако, ключ API — это имя, данное некоторой форме секретного токена, который отправляется вместе с запросами веб-службы (или аналогичными), чтобы идентифицировать источник запроса. Ключ может быть включен в некоторый дайджест содержимого запроса для дальнейшей проверки источника и предотвращения подделки значений.
Как правило, если вы можете идентифицировать источник запроса положительно, он действует как форма аутентификации, которая может привести к контролю доступа. Например, вы можете ограничить доступ к определенным действиям API в зависимости от того, кто выполняет запрос. Для компаний, которые зарабатывают деньги на продаже таких услуг, это также способ отслеживать, кто использует эту вещь для выставления счетов. Кроме того, блокируя ключ, вы можете частично предотвратить злоупотребление в случае слишком больших объемов запросов.
В общем, если у вас есть как открытый, так и закрытый ключ API , то это говорит о том, что сами ключи являются традиционной парой открытых/закрытых ключей, используемой в той или иной форме асимметричной криптографии или связанной с ней цифровой подписи. Это более безопасные методы для положительной идентификации источника запроса и, кроме того, для защиты содержимого запроса от слежки (в дополнение к вмешательству).
Поделиться Rob 21 сентября 2009 в 06:22
24
В целом:
An API ключ просто идентифицирует вас.
Если существует различие между публичным и частным, то открытый ключ-это тот, который вы можете распространять другим, чтобы позволить им получить некоторое подмножество информации о вас из api. Закрытый ключ предназначен только для вашего использования и обеспечивает доступ ко всем вашим данным.
Поделиться timdev 21 сентября 2009 в 06:17
18
Похоже, что многие люди используют ключи API в качестве решения для обеспечения безопасности. Суть в следующем:
Лучшее описание находится в ссылке Евгения Осовецкого: при работе с большинством APIs, почему они требуют двух типов аутентификации, а именно ключа и секрета? Или проверьте http://nordicapis.com/why-api-keys-are-not-enough/
Поделиться timandtheocean
- В чем фокус Tumblr API и получить ключ API?
Я пытаюсь понять Tumblr API (v2), но я думаю, что документация немного запутана для начинающих. То, что я делаю прямо сейчас, — это делаю простые и общедоступные скрипты, то есть только javascript (frontend), например скрипт, который определяет, нравится ли пользователю уже пост в самом блоге. По…
- Что такое ключ begin?
Я имел дело с проблемой KeyEvent . Я хотел поймать клавишу Begin для быстрого доступа, но не смог, потому что контроллер этого не заметил. Наконец я понимаю, что пытался поймать не тот ключ. Я должен был поймать ключ Home . ( KeyEvent.VK_HOME ) Я нашел это в исходном коде: /** * Constant for the…
10
Ключ An API-это уникальное значение, которое присваивается пользователю данного сервиса, когда он принимается в качестве пользователя сервиса.
Служба поддерживает все выданные ключи и проверяет их при каждом запросе.
Глядя на предоставленный ключ по запросу, служба проверяет, является ли он действительным ключом, чтобы решить, предоставлять ли доступ пользователю или нет.
Поделиться Unknown 21 сентября 2009 в 06:16
2
API ключи — это всего лишь один из способов аутентификации пользователей веб-сервисов.
Поделиться GG. 21 сентября 2009 в 06:45
1
Подумайте об этом так: «Ключ Public API» похож на имя пользователя, которое ваша база данных использует в качестве входа на сервер проверки. Тогда «ключ Private API» будет похож на пароль. С помощью сайта / базы данных, использующего этот метод, безопасность поддерживается на стороннем / проверочном сервере для того, чтобы аутентифицировать запрос на публикацию или редактирование вашего site/database.
Строка The API — это всего лишь URL логина для вашего сайта/базы данных, чтобы связаться с сервером проверки.
Поделиться Eugene Grant-Sinclair 21 октября 2013 в 20:26
Похожие вопросы:
Для чего нужен ключ API в Google Maps API V3?
В более старой версии API мне пришлось бы вставить javascript на страницу, используя что-то вроде этого, чтобы работать только с базовой функциональностью:.
Что такое ключ «opaque»?
Я знаю, что такое ключ, я знаю, что такое непрозрачный в других контекстах — но что такое непрозрачный ключ в контексте базы данных?
Что такое внешний ключ?
Хорошо. Итак, я знаю, что такое первичный ключ в DB. Если у вас есть таблица в базе данных, первичный ключ — это единственное значение, уникальное для каждой строки в вашей таблице. Например: id |…
Firebase-что такое ключ API
В Firebase, когда мы регистрируемся, он дает нам ключ API для каждого firebase Url. Но где он используется в потребляющем приложении? fireBase API не предоставляет никаких средств для поставки ключа…
Что такое ключ Fabric API?
Как мы создаем наше приложение в dev.twitter.com / apps Мы получаем ниже подробную информацию:- Ключ Потребителя (Ключ API) Потребительский Секрет (API Секрет) Так где же ключ от ткани ? В файле…
В чем фокус Tumblr API и получить ключ API?
Я пытаюсь понять Tumblr API (v2), но я думаю, что документация немного запутана для начинающих. То, что я делаю прямо сейчас, — это делаю простые и общедоступные скрипты, то есть только javascript…
Что такое ключ begin?
Я имел дело с проблемой KeyEvent . Я хотел поймать клавишу Begin для быстрого доступа, но не смог, потому что контроллер этого не заметил. Наконец я понимаю, что пытался поймать не тот ключ. Я…
Что такое ключ-кандидат и первичный ключ?
У меня есть два стола: tblTrip (primaryKey: tripNo) tblPerson (primaryKey: personID) отношение между этими 2 таблицами равно n:n Итак, существует реляционная таблица: tblParticipateIn (tripNo,…
Что такое ключ Android hash?
Я попробовал посмотреть, что такое Android ключ hash в Google. Но все, что я получил, это то, как его генерировать, а не то, что на самом деле это такое. Может ли кто-нибудь дать простое объяснение…
Что такое первичный ключ
В коде базы данных я вижу ссылки на PRIMARY KEY . Что такое первичный ключ и какая разница, если некоторые столбцы в одной из моих таблиц образуют первичный ключ. .. или не образуют первичный ключ….
Проверка подлинности ключа API — Azure Cognitive Search
- Чтение занимает 4 мин
В этой статье
Всем запросам к службе поиска требуется ключ API только для чтения, созданный специально для вашей службы.All requests to a search service need a read-only API key that was generated specifically for your service. Ключ API является единственным механизмом проверки подлинности входящих запросов к конечной точке службы поиска и требуется при каждом запросе.The API key is the sole mechanism for authenticating inbound requests to your search service endpoint and is required on every request.
Вы можете просматривать ключи API и управлять ими в портал Azureили с помощью PowerShell, Azure CLIили REST API. You can view and manage API keys in the Azure portal, or through PowerShell, Azure CLI, or REST API.
Что такое ключ API?What is an API key?
Ключ API — это уникальная строка, состоящая из случайных чисел и букв, которые передаются при каждом запросе к службе поиска.An API key is a unique string composed of randomly generated numbers and letters that is passed on every request to the search service. Служба примет запрос, если сам запрос и ключ действительны.The service will accept the request, if both the request itself and the key are valid.
Для доступа к службе поиска используются два типа ключей: ключи администратора (для чтения и записи) и ключи запроса (только для чтения).Two types of keys are used to access your search service: admin (read-write) and query (read-only).
КлавишиKey | ОписаниеDescription | ОграниченияLimits |
---|---|---|
АдминистративныйAdmin | Предоставляет полный доступ ко всем операциям, включая возможность управлять службой, создавать и удалять индексы, индексаторы и источники данных. Grants full rights to all operations, including the ability to manage the service, create and delete indexes, indexers, and data sources. При создании службы генерируются два ключа администратора, которые на портале называются первичным и вторичным. При необходимости их можно создать заново независимо друг от друга.Two admin keys, referred to as primary and secondary keys in the portal, are generated when the service is created and can be individually regenerated on demand. При наличии двух ключей один ключ можно сменить, а второй использовать для непрерывного доступа к службе.Having two keys allows you to roll over one key while using the second key for continued access to the service. Ключи администратора указываются только в заголовках HTTP-запросов.Admin keys are only specified in HTTP request headers. Невозможно разместить ключ API администратора в URL-адресе.You cannot place an admin API key in a URL. | Не более 2 на службуMaximum of 2 per service |
ЗапросQuery | Предоставляет только разрешение на чтение индексов и документов; обычно они добавляются в клиентские приложения, которые создают запросы на поиск. Grants read-only access to indexes and documents, and are typically distributed to client applications that issue search requests. Ключи запроса создаются по запросу.Query keys are created on demand. Ключи запроса можно указать в заголовке HTTP-запроса для операции поиска, предложения или уточняющего запроса.Query keys can be specified in an HTTP request header for search, suggestion, or lookup operation. Кроме того, ключ запроса можно передать как параметр в URL-адресе.Alternatively, you can pass a query key as a parameter on a URL. В зависимости от того, как клиентское приложение формирует запрос, возможно, проще передать ключ в качестве параметра запроса:Depending on how your client application formulates the request, it might be easier to pass the key as a query parameter:
| 50 на службу50 per service |
Визуально нет никакой разницы между ключом администратора и ключом запроса. Visually, there is no distinction between an admin key or query key. Оба ключа представляют собой строки из 32 случайно сгенерированных буквенно-цифровых символов.Both keys are strings composed of 32 randomly generated alpha-numeric characters. Если вы потеряли, какой тип ключа указан в приложении, можно проверить значения ключей на портале.If you lose track of what type of key is specified in your application, you can check the key values in the portal.
Примечание
Это считается низкой практикой в области безопасности при передаче конфиденциальных данных, например, api-key
в URI запроса.It’s considered a poor security practice to pass sensitive data such as an api-key
in the request URI. По этой причине Azure Когнитивный поиск принимает только ключ запроса api-key
в строке запроса, и следует избегать этого, если содержимое индекса не должно быть общедоступным.For this reason, Azure Cognitive Search only accepts a query key as an api-key
in the query string, and you should avoid doing so unless the contents of your index should be publicly available. Как правило, мы рекомендуем передавать api-key
в заголовке запроса.As a general rule, we recommend passing your api-key
as a request header.
Найти существующие ключиFind existing keys
Ключи доступа можно получить на портале или с помощью PowerShell, Azure CLIили REST API.You can obtain access keys in the portal or through PowerShell, Azure CLI, or REST API.
Войдите на портал Azure.Sign in to the Azure portal.
Перечислите службы поиска для своей подписки.List the search services for your subscription.
Выберите службу и на странице Обзор щелкните Параметры > ключи , чтобы просмотреть ключи администратора и запроса.Select the service and on the Overview page, click Settings >Keys to view admin and query keys.
Создание ключей запросаCreate query keys
Ключи запроса используются для доступа только для чтения к документам в индексе для операций, предназначенных для коллекции документов. Query keys are used for read-only access to documents within an index for operations targeting a documents collection. Запросы поиска, фильтрации и предложений — это все операции, которые принимают ключ запроса.Search, filter, and suggestion queries are all operations that take a query key. Любая операция только чтения, возвращающая системные данные или определения объектов, например определение индекса или состояние индексатора, требует наличия ключа администратора.Any read-only operation that returns system data or object definitions, such as an index definition or indexer status, requires an admin key.
Ограничения доступа и операций в клиентских приложениях необходимы для защиты ресурсов поиска в службе.Restricting access and operations in client apps is essential to safeguarding the search assets on your service. Всегда используйте ключ запроса, а не ключ администратора для любого запроса, исходящего из клиентского приложения.Always use a query key rather than an admin key for any query originating from a client app.
Войдите на портал Azure.Sign in to the Azure portal.
Выведите список служб поиска для вашей подписки.List the search services for your subscription.
Выберите службу и на странице Обзор щелкните Параметры > ключи.Select the service and on the Overview page, click Settings >Keys.
Щелкните Управление ключами запроса.Click Manage query keys.
Используйте ключ запроса, уже созданный для вашей службы, или создайте до 50 новых ключей запроса.Use the query key already generated for your service, or create up to 50 new query keys. Ключ запроса по умолчанию не именован, но для управляемости можно назвать дополнительные ключи запроса.The default query key is not named, but additional query keys can be named for manageability.
Примечание
Пример кода, демонстрирующий использование ключа запроса, можно найти в дотнесовто. A code example showing query key usage can be found in DotNetHowTo.
Повторное создание ключей администратораRegenerate admin keys
Для каждой службы создаются два ключа администратора, чтобы можно было поворачивать первичный ключ, используя вторичный ключ для обеспечения непрерывности бизнес-процессов.Two admin keys are created for each service so that you can rotate a primary key, using the secondary key for business continuity.
- На странице > ключи параметров скопируйте вторичный ключ.In the Settings >Keys page, copy the secondary key.
- Для всех приложений обновите параметры ключа API, чтобы они использовали вторичный ключ.For all applications, update the API key settings to use the secondary key.
- Заново создайте первичный ключ.Regenerate the primary key.
- Обновите все приложения, указав новый первичный ключ.Update all applications to use the new primary key.
Если случайно создать оба ключа одновременно, все клиентские запросы, использующие эти ключи, завершатся ошибкой HTTP 403 запрещено. If you inadvertently regenerate both keys at the same time, all client requests using those keys will fail with HTTP 403 Forbidden. Однако содержимое не удаляется, и вы не блокируете его без возможности восстановления.However, content is not deleted and you are not locked out permanently.
Вы по-прежнему можете получить доступ к службе через портал или программным способом.You can still access the service through the portal or programmatically. Функции управления работают с ИДЕНТИФИКАТОРом подписки, а не ключом API службы и, таким же, доступны даже в том случае, если ключи API не используются.Management functions are operative through a subscription ID not a service API key, and thus still available even if your API keys are not.
После создания новых ключей с помощью портала или слоя управления доступ восстанавливается в содержимое (индексы, индексаторы, источники данных, карты синонимов), когда у вас есть новые ключи и эти ключи задаются в запросах.After you create new keys via portal or management layer, access is restored to your content (indexes, indexers, data sources, synonym maps) once you have the new keys and provide those keys on requests.
Безопасные ключи APISecure API keys
Используя разрешения на основе ролей, вы можете удалять или считывать ключи, но не можете заменить ключ пользовательским паролем или использовать Active Directory в качестве основного метода проверки подлинности для доступа к операциям поиска.Through role-based permissions, you can delete or read the keys, but you can’t replace a key with a user-defined password or use Active Directory as the primary authentication methodology for accessing search operations.
Безопасность ключей API обеспечивается за счет ограничения доступа на портале или в интерфейсах Resource Manager (PowerShell или интерфейс командной строки).Key security is ensured by restricting access via the portal or Resource Manager interfaces (PowerShell or command-line interface). Как уже отмечалось, администраторы подписки могут просматривать и повторно создавать все ключи API.As noted, subscription administrators can view and regenerate all API keys. В качестве меры предосторожности проверьте назначения ролей, чтобы понять, кто имеет доступ к ключам администратора. As a precaution, review role assignments to understand who has access to the admin keys.
- На панели мониторинга службы щелкните Управление доступом (IAM), а затем — вкладку Назначения ролей, чтобы просмотреть назначенные роли для службы.In the service dashboard, click Access control (IAM) and then the Role assignments tab to view role assignments for your service.
Просмотр и повторное создание ключей доступны для следующих ролей: владелец, участник, участник службы поиска.Members of the following roles can view and regenerate keys: Owner, Contributor, Search Service Contributors
См. такжеSee also
Ключи API с ограниченной областью действия
- Чтение занимает 5 мин
В этой статье
Чтобы обеспечить эффективную защиту среды NuGet при распространении пакетов, вы можете управлять ключами API, добавляя области действия. To make NuGet a more secure environment for package distribution, you can take control of the API keys by adding scopes.
Ограничивая область действия ключей API, вы оптимизируете управление API.The ability to provide scope to your API keys give you better control on your APIs. Вы можете:You can:
- Создавать несколько ключей API с ограниченной областью действия, которые могут использоваться для различных пакетов с разными сроками действия.Create multiple scoped API keys that can be used for different packages with varying expiration timeframes.
- Безопасно получать ключи API.Obtain API keys securely.
- Редактировать существующие ключи API, изменяя параметры применимости для пакета.Edit existing API keys to change package applicability.
- Обновлять или удалять существующие ключи API, не мешая операциям, использующим другие ключи.Refresh or delete existing API keys without hampering operations using other keys.
Для чего нужна поддержка ключей API с ограниченной областью действия?Why do we support scoped API keys?
Поддержка ключей API с ограниченной областью действия позволяет более детально настраивать разрешения. We support scopes for API keys to allow you to have more fine-grained permissions. Ранее в NuGet использовался один ключ API для учетной записи, что имело ряд недостатков.Previously, NuGet offered a single API key for an account, and that approach had several drawbacks:
- Один ключ API для управления всеми пакетами.One API key to control all packages. Поскольку для управления всеми пакетами использовался один ключ API, было сложно обеспечить безопасность при совместном использовании ключа несколькими разработчиками, которые работают с разными пакетами в рамках одной учетной записи издателя.With a single API key that is used to manage all packages, it is difficult to securely share the key when multiple developers are involved with different packages, and when they share a publisher account.
- Невозможность назначать частичные разрешения.All permissions or none. Любой пользователь, имеющий доступ к ключу API, получал все разрешения в отношении пакетов, в том числе для их публикации, отправки и исключения из списка. Anyone with access to the API key has all permissions (publish, push and un-list) on the packages. В среде с несколькими командами такое поведение зачастую нежелательно.This is often not desirable in environment with multiple teams.
- Единственная точка сбоя.Single point of failure. Использование одного ключа API также приводит к возникновению единой точки отказа.A single API key also means a single point of failure. Если такой ключ становится известен посторонним лицам, под угрозу могут попасть все пакеты, связанные с учетной записью.If the key is compromised, all packages associated with the account could potentially be compromised. В таком случае единственным способом предотвратить утечку и избежать нарушений в рабочем процессе непрерывной интеграции и развертывания становится обновление ключа API.Refreshing the API key is the only way to plug the leak and avoid an interruption to your CI/CD workflow. Кроме того, возможны случаи, в которых требуется отозвать права доступа к ключу API у одного пользователя (например, если он или она покидает организацию). In addition, there may be cases when you want to revoke access to the API key for an individual (for example, when an employee leaves the organization). На данный момент удобного выхода из такой ситуации не существует.There isn’t a clean way to handle this today.
Используя ключи API с ограниченной областью действия, мы пытаемся решить эти проблемы и обеспечить непрерывность существующих рабочих процессов.With scoped API keys, we try to address these problems while making sure that none of the existing workflows break.
Получение ключа APIAcquire an API key
Войдите в учетную запись nuget.org или создайте учетную запись (если ее еще нет).Sign into your nuget.org account or create an account if you don’t have one already.
См. подробнее о создании индивидуальной учетной записи.For more information on creating your account, see Individual accounts.
Выберите свое имя пользователя (в правом верхнем углу), а затем щелкните Ключи API. Select your user name (on the upper right), then select API Keys.
Щелкните Create (Создать), введите имя ключа, а затем выберите Select Scopes (Выбрать области) > Push (Отправить) .Select Create, provide a name for your key, select Select Scopes > Push. Введите * в поле Glob pattern (Стандартная маска), а затем выберите Create (Создать).Enter * for Glob pattern, then select Create. (Дополнительные сведения об областях см. ниже.)(See below for more about scopes.)
После создания ключа выберите Копировать для получения ключа доступа, который требуется в интерфейсе командной строки:Once the key is created, select Copy to retrieve the access key you need in the CLI:
Важно. Сохраните ключ в безопасном расположении, так как позже вы не сможете скопировать его. Important: Save your key in a secure location because you cannot copy the key again later on. Если вы вернетесь на страницу ключа API, вам понадобится повторно создать ключ, чтобы скопировать его.If you return to the API key page, you need to regenerate the key to copy it. Вы также можете удалить ключ API, если больше не хотите отправлять пакеты через интерфейс командной строки.You can also remove the API key if you no longer want to push packages via the CLI.
Определение области позволяет создавать отдельные ключи API для разных целей.Scoping allows you to create separate API keys for different purposes. Ключи имеют срок действия. Кроме того, их можно привязать к определенным пакетам (или стандартным маскам).Each key has its expiration timeframe and can be scoped to specific packages (or glob patterns). Каждый ключ также привязан к конкретным операциям: отправка новых пакетов и обновлений, отправка только обновлений или удаление из списка.Each key is also scoped to specific operations: push of new packages and updates, push of updates only, or delisting. Используя определение области, вы можете создавать ключи API разным пользователям, которые управляют пакетами организации. Это позволит предоставлять им только нужные разрешения.Through scoping, you can create API keys for different people who manage packages for your organization such that they have only the permissions they need. См. подробнее о ключах API в определении области.For more information, see scoped API keys.
Создание ключей API с ограниченной областью действияCreate scoped API keys
Вы можете создавать несколько ключей API в соответствии с потребностями.You can create multiple API keys based on your requirements. Ключи API могут применяться к одному или нескольким пакетами, иметь разные области действия с уникальными привилегиями, а также разные сроки действия.An API key can apply to one or more packages, have varying scopes that grant specific privileges, and have an expiration date associated with it.
В следующем примере показан ключ API с именем Contoso service CI
, который можно использовать для отправки пакетов для Contoso. Service
на протяжении 365 дней.In the following example, you have an API key named Contoso service CI
that can be used to push packages for specific Contoso.Service
packages, and is valid for 365 days. Это типичный сценарий, в котором различные команды работают с разными пакетами в рамках одной организации. В этом случае членам команды предоставляется ключ, дающий привилегии для работы только с назначенными им пакетами.This is a typical scenario where different teams within the same organization work on different packages, and the members of the team are provided the key that grants them privileges only for the package they are working on. Ограничение срока действия позволяет предотвратить устаревание или утрату ключей.The expiration serves as a mechanism to prevent stale or forgotten keys.
Использование стандартных масокUse glob patterns
Если вы управляете большим списком пакетов, для одновременного выбора нескольких пакетов можно использовать стандартные маски. If you are working on multiple packages and have a large list of packages to manage, you can choose to use globbing patterns to select multiple packages together. Например, если вы хотите задать области действия ключа для всех пакетов, идентификатор которых начинается с Fabrikam.Service
, необходимо указать fabrikam.service.*
в текстовом поле Стандартная маска.For example, if you wish to grant specific scopes to a key for all packages whose ID starts with Fabrikam.Service
, you could do this by specifying fabrikam.service.*
in the Glob pattern text box.
Если разрешения для ключа API определяются на основе стандартной маски, они будут применяться к новым пакетам, которые соответствуют этой маске.Using glob patterns to determine API key permissions also applies to new packages matching the glob pattern. Например, для отправки пакета с названием Fabrikam.Service.Framework
вы можете использовать ранее созданный ключ, поскольку этот пакет соответствует стандартной маске fabrikam. service.*
.For example, if you try to push a new package named Fabrikam.Service.Framework
, you can do that with the key created previously, since the package matches the glob pattern fabrikam.service.*
.
Безопасное получение ключей APIObtain API keys securely
В целях безопасности создаваемый ключ никогда не отображается на экране и может использоваться только посредством кнопки Копировать.For security, a newly created key is never shown on the screen and is only available using the Copy button. Ключ также будет недоступен в случае обновления страницы.Similarly, the key is not accessible after the page is refreshed.
Изменение существующих ключей APIEdit existing API keys
Вы также можете обновить разрешения и области действия для ключа, не изменяя сам ключ.You may also want to update the key permissions and scopes without changing the key itself. Если у вас есть ключ с заданными областями действия для одного пакета, вы можете применить эти области к одному или нескольким другим пакетам. If you have a key with specific scope(s) for a single package, you can choose to apply the same scope(s) on one or many other packages.
Обновление или удаление существующих ключей APIRefresh or delete existing API keys
Владелец учетной записи может обновить ключ. При этом выдается новый ключ с теми же разрешениями (в отношении пакетов), областями и сроками действия, а старый ключ выводится из обращения.The account owner can choose to refresh the key, in which case the permission (on packages), scope, and expiry remain the same, but a new key is issued making the old key unusable. Это позволяет предотвратить устаревание ключей API и защититься от риска их утечки.This is helpful in managing stale keys or where there is any potential for an API key leakage.
Также вы можете удалять неиспользуемые ключи.You may also choose to delete these keys if they are not needed anymore. В этом случае ключ выводится из обращения.Deleting a key removes the key and makes it unusable.
Часто задаваемые вопросыFAQs
Что происходит с устаревшим ключом API?What happens to my old (legacy) API key?
Устаревший ключ API продолжает действовать до тех пор, пока вам это необходимо.Your old API key (legacy) continues to work and can work as long as you want it to work. Тем не менее, такие ключи выводятся из обращения, если они не использовались для отправки пакетов более 365 дней.However, these keys will be retired if they have not been used for more than 365 days to push a package. Дополнительные сведения см. в записи блога, посвященной изменению существующих ключей API.For more details, see the blog post Changes to expiring API keys. Дальнейшее обновление такого ключа невозможно.You can no longer refresh this key. При необходимости вам потребуется удалить устаревший ключ и создать вместо него новый ключ с ограниченной областью действия.You need to delete the legacy key and create a new scoped key instead.
Примечание
Этот ключ будет иметь все разрешения в отношении всех пакетов и неограниченный срок действия. This key has all permissions on all the packages and it never expires. В таких случаях рекомендуется удалить этот ключ и создать вместо него новые ключи с ограниченными областями и сроками действия.You should consider deleting this key and creating new keys with scoped permissions and definite expiry.
Сколько ключей API можно создавать?How many API keys can I create?
Количество создаваемых ключей API не ограничивается.There is no limit on the number of API keys you can create. Тем не менее, чтобы эффективно контролировать устаревшие ключи и параметры их использования, рекомендуется не превышать удобное для управления количество ключей.However, we advise you to keep it to a manageable count so that you do not end up having many stale keys with no knowledge of where and who is using them.
Можно ли удалить устаревший ключ API или перестать использовать его?Can I delete my legacy API key or discontinue using now?
Да.Yes. Вы можете и скорее всего должны удалять устаревшие ключи API. You can—and you probably should—delete your legacy API key.
Можно ли восстановить ошибочно удаленный ключ API?Can I get back my API key that I deleted by mistake?
Нет.No. После удаления вы можете только создавать новые ключи.Once deleted, you can only create new keys. Возможность восстанавливать случайно удаленные ключи не предусматривается.There is no recovery possible for accidentally deleted keys.
Продолжает ли старый ключ API работать после обновления ключа API?Does the old API key continue to work upon API key refresh?
Нет.No. После обновления ключа создается новый ключ с теми же разрешениями, областями и сроками действия.Once you refresh a key, a new key gets generated that has the same scope, permission, and expiry as the old one. Старый ключ при этом выводится из обращения.The old key ceases to exist.
Могу ли я предоставить дополнительные разрешения для существующего ключа API?Can I give more permissions to an existing API key?
Вы не можете изменять область действия, однако имеете возможность изменить список пакетов, к которым применяется ключ. You cannot modify the scope, but you can edit the package list it is applicable to.
Как узнать, срок действия каких ключей истекает или уже истек?How do I know if any of my keys expired or are getting expired?
Если срок действия какого-либо ключа скоро истечет, вы увидите соответствующее предупреждающее сообщение в верхней части страницы.If any key expires, we will let you know through a warning message at the top of the page. Кроме того, за десять дней до истечения срока действия ключа мы отправим владельцу учетной записи по электронной почте предупреждение, чтобы вы могли заблаговременно предпринять необходимые действия.We also send a warning e-mail to the account holder ten days before the expiration of the key so that you can act on it well in advance.
Как получить API Key для карт Google?
Если на вашем сайте иногда не показывается карта Яндекса или Google с отображением адреса офиса/магазина, воспользуйтесь данным решением.0. Переключите отображение адреса на карты Google.
1. Перейдите в Google Cloud Platform Console.
2. Примите условия использования сервиса.
3. Нажмите на кнопку «Создать».
4. Введите название проекта и нажмите кнопку «Создать».
5. Выберите в каталоге «Geocoding API» и «Maps JavaScript API».
6. Нажмите кнопку «Включить».
7. Переключитесь на вкладку «Учетные данные».
8. Нажмите кнопку «Создать учетные данные».
9. Выберите «Ключ API».
10. Скопируйте полученный ключ API и нажмите «Закрыть».
11. На плашке вверху страницы нажмите кнопку «Активировать бесплатный пробный период».
12. Согласитесь с условиями использования.
13. Заполните поля, включая данные своей банковской карты. Карта должна быть у вас, т.к. на одном из следующих шагов ее нужно будет сфотографировать.
14. Нажмите «Перейти к подтверждению».
15. С вашей банковской карты будет списано 1-2 доллара для проверки. В течение часа эти деньги вернутся.
16. Заполните форму (фото банковской карты, на которой видно 4 последних цифры + фото паспорта/водительских прав и т.д.).
17. Перейдите в панель управления сайтом — Приложения — Google Maps и вставьте в нужное поле скопированный ключ API.
18. Согласно инструкции (ссылка) выберите на странице Контакты — Показывать на Google Map.
19. Готово!
Обратите внимание!
Стоимость использования сервиса составляет 7 долларов за 1000 просмотров (до 100 000 просмотров в год) и 5,6 доллара за 1000 просмотров (от 100 001 до 500 000 просмотров в год). На первый год Google дает 300 долларов в подарок (их хватит на 3571 просмотр страницы с картами в месяц в среднем). Обратите внимание, оплата не начнет списываться автоматически, пока вы не подтвердите платную подписку.
Была ли статья вам полезна? Да Нет
Рабочий API KEY для YouTube.
Как получить этот ключ?Далеко не каждый знает, что ключ ApiKey для YouTube, можно получить от сервиса Google, а дальше с помощью ключа api key вы сможете просматривать на своей приставке (Т2 или спутниковой, …..) приложение YouTube, без затыков, с работающим поиском, вообщем как и должно быть. Так, что-ж для этого нужно? и как его получить! Мы расскажем ниже.
Получить ключ apikey, вы сможете от самого google как и упоминал я уже выше. На день написания этой статьи эта процедура идёт бесплатно, а что google в дальнейшем надумает с этими ключами и какие он преследует конечные цели, наверно знает только сам google, будем надеяться, что всё так и останется.
Хочу сразу обмолвится, перед тем как создать ключ api key у меня уже был аккаунт в youtube, поэтому мне его просто подвязало, а если у кого нет аккаунта, возможно нужно будет пройти какую то регистрацию.
Что-бы получить ключ api key от youtube необходимо первым делом перейти в приложение Google APIs, а конкретнее вот по этой ссылке, в открывшемся окне вы увидите много разных сервисов от google. Вам необходимо найти один вот с таким названием — (YouTube Data API v3) Заходите в него.
Далее жмёте по кнопке (включить), как на картинке ниже.
Откроется новое окно, в котором в правом верхнем углу необходимо будет кликнуть по кнопке (Создать).
В следующем окне вы используете такие данные.
- 1 выставляете тип учётных данных (YouTube Data API v3)
- 2 Указываете точные настройки (например, node.js, Tomcat)
- 3 Выбираете (Общедоступные данные)
- 4 И жмёте по кнопке (Выбрать тип учётных данных)
Происходит создание учётных данных. Вам необходимо кликнуть по кнопке (Готово) для сохранения этих данных.
И вот конечная страница, в которой я показываю стрелкой где будет ваш ключ apikey, так же на этой странице вы можете ввести ограничение для ключа, создать новый.
А для того что бы использовать этот apikey ключ для просмотра youtube на вашей приставке Т2 или спутниковой, необходимо его скопировать и внести в файл (. XML), об этом подробно читайте здесь. После чего данный файл необходимо залить в свою приставку.
Разумеется свой ключ api key не распространяйте в открытом доступе в интернете, так как он закреплён за вашим аккаунтом.
Как ключ API Key залить в Т2 приставку — Читаем здесь
Как ключ API Key залить в спутниковый ресивер — Читаем здесь
Если у вас не получается создать ключ APIKey и вам пишет: Не достаточно прав… или создать новый проект то вам поможет эта статья.
Интересные Статьи
Получаем ключ авторизации | learnapidoc-ru
Edit meПочти каждый сайт API имеет метод для аутентификации запросов. Обычно мы предоставляем ключ API в своих запросах для получения ответа. Сейчас нам нужно получить ключи API, чтобы отправлять запросы нашему API погоды, а позже изучим аутентификацию и авторизацию подробнее.
Зачем запросу нужна авторизация
Требование авторизации позволяет издателям API делать следующее:
- лицензированный доступ к API;
- оценка лимита количества запросов;
- Контроль доступа определенных функций в API и многое другое.
Для запуска примеров кода в этом курсе нам нужно будет использовать свои собственные ключи API, поскольку эти ключи обычно обрабатываются как пароли и не выдаются или не публикуются открыто на веб-странице.
Tip: Если вы хотите позаимствовать ключи API автора курса, вы можете получить их здесь. Иногда бывает, участники семинара зацикливаются на попытках получить ключи API, поэтому автор опубликовал свои ключи здесь, чтобы избежать задержек в работе.👨💻 Практика: Получаем ключ авторизации OpenWeatherMap API
- Переходим на страницу https://openweathermap.org
- Нажимаем
Sign Up
в навигационной панели и создать аккаунт - После создания аккаунта вернуться на страницу https://openweathermap. org и кликнуть
Sign in
- После входа попадаем в панель разработчика. Кликаем на плашку
API key
- Сохраняем сгенерированный ключ в удобном месте.
Получаем секретный код и ID Aeris Weather API
И для контраста, давайте получим ключи для Aeris Weather API. Aeris Weather API требует секретного кода и идентификатора для отправки запросов.
- Открываем сайт http://www.aerisweather.com и нажимаем кнопку
Get started for free
(бесплатная версия ограничивает количество запросов, которые можно сделать). - Вводим username, email и пароль, после чего нажимаем
Sign up for free
для создания аккаунта в сервисе Aeris. После этого входим в аккаунт. - После входа в аккаунт нажимаем
Account
в правом верхнем углу. - Нажимаем
Apps
(во втором навигационном ряду справа отUsage
) и там выбираемNew Application
- В диалоговом окне Add a New Application вводим следующее:
- Application Name: My biking app (или что-то в этом духе)
- Application Namespace: localhost
- Нажимаем
Save App
.
После регистрации приложения мы должны увидеть его идентификатор, секретный код и пространство имен. Скопируем эту информацию в место, к которому можем легко получить доступ, так как оно понадобится вам для отправки запросов.
Tip: Помните, то как пользователи авторизуют вызовы с помощью API — это то, что вы обычно описываете в документации API. Далее в курсе мы более подробно рассмотрим методы авторизации.Текстовый редактор
В предстоящих практических занятиях мы будем работать с кодом в текстовом файле. Для работы с кодом, мы используем текстовый редактор plain text вместо редактора WYSIWYG). Вот несколько вариантов для текстовых редакторов:
Эти редакторы предоставляют функции, которые позволяют вам лучше управлять текстом. Выберите тот, который вы хотите. Избегайте использования TextEdit, так как он добавляет скрытое форматирование, которое может повредить ваш контент.
🔙
Go next ➡
your api key — Перевод на русский — примеры английский
На основании Вашего запроса эти примеры могут содержать грубую лексику.
На основании Вашего запроса эти примеры могут содержать разговорную лексику.
If you created this key before, but it has expired, you should renew your API key by this link.
Предложить пример
Другие результаты
This is to allow you to access the settings page of the plugin where you can enter your Google API key or get one and eventually define a height and width for your default Google Maps.
Это сделано, чтобы получить доступ к странице настроек плагина, где вы можете ввести ключ Google API или получить один и в конечном итоге определить высоту и ширину по умолчанию Google Maps.Visit the Extensions -> GeoTag tab and paste Google API key from Google Maps API and set Custom field name for Latitude and Longitude.
Последуйте в вкладку Расширения -> GeoTag и вставьте ключ Google API, который можно взять по этой ссылке Google Maps API, также установите для широты и долготы выбранные пользовательские поля.In order to get temporary API key you need: accept terms of agreement, specify email address where the key will be sent to and specify address of your site where results will be shown.
Для создания временного ключа, который позволит вам получать результаты футбольных матчей в течение 48 часов, вам необходимо принять условия соглашения, указать адрес электронной почты, куда будет выслан ключ и указать адрес сайта, для которого вам нужны эти результаты.API server: The API server is a key component and serves the Kubernetes API using JSON over HTTP, which provides both the internal and external interface to Kubernetes.
Сервер API — ключевой компонент подсистемы управления, предоставляющий API в стиле REST (с использованием коммуникации в формате JSON поверх HTTP-транспорта), и используемый для организации внешнего и внутреннего доступа к функциям Kubernetes.Key features include: Simple API similar to Berkeley sockets.
Ключевые особенности: Простой API, похожий на сокеты Berkeley.key for connecting to Google Safe Browsing API and perform updates.
ключ для подключения к серверу Google Safe Browsing API и скачиывания обновлений с него.The bulk of production takes place in high-income countries, alongside India as a major manufacturing hub for generic products and China as a key source of active pharmaceutical ingredients (APIs).
Основная часть таких производств сосредоточена в странах с высокими доходами, а также в Индии, являющейся крупным центром производства непатентованных средств, и Китае, выступающем в роли ключевого поставщика активных фармацевтических ингредиентов (АФИ).The API defines most commonly used cryptographic object types (RSA keys, X. Certificates, DES/Triple DES keys, etc.) and all the functions needed to use, create/generate, modify and delete those objects.
API описывает часто используемые типы криптографических объектов (RSA ключи, Сертификаты X., Ключи DES/Triple DES, и т. п.) и все функции необходимые для использования, создания или генерации, модификации и удаления этих объектов.Provides information on the syntax and usage of supported elements in the ActionScript 3. 0 language. Includes appendixes that compare key language and API changes from ActionScript 2.0 to ActionScript 3.0 and descriptions of Flash Player errors and warnings.
Содержит информацию о синтаксисе и использовании поддерживаемых элементов в языке ActionScript 3.0, включая приложения, в которых освещаются основные различия языка и API между ActionScript 2.0 и ActionScript 3.0, а также описываются ошибки и предупреждения в Flash Player.One of the key features of CherryPlayer is support of such audio services 4shared SoundCloud VK YouTube video services 4shared Twitch VK YouTube YouTube, Twitch and VKontakte are supported with the native API of these sites.
Ключевой особенностью CherryPlayer является поддержка таких аудио сервисов 4shared Soundcloud ВКонтакте YouTube видео сервисов 4shared Twitch ВКонтакте YouTube YouTube, Twitch и ВКонтакте поддерживаются с использованием нативных API этих сайтов.Что такое ключ API? | Определение ключа API
Ключ API или ключ интерфейса прикладного программирования — это код, который передается компьютерными приложениями. Затем программа или приложение вызывает API или интерфейс прикладного программирования для идентификации своего пользователя, разработчика или вызывающей программы на веб-сайте.
Ключи прикладного программирования обычно используются для помощи в отслеживании и контроле использования интерфейса. Часто это делается для предотвращения злоупотреблений или злонамеренного использования рассматриваемого API.
Ключ API может действовать как секретный токен аутентификации, а также как уникальный идентификатор. Обычно ключ поставляется с набором прав доступа для API, с которым он связан.
Связано: ключи API в RapidAPI
Когда и зачем использовать ключи API
Ключи API используются с проектами, а аутентификация предназначена для пользователей. Во многих случаях Cloud Endpoints будут обрабатывать как процедуры аутентификации, так и ключи API. Различие между ними:
- Токены аутентификации используются для идентификации пользователей, т.е.д., человек, который использует этот конкретный веб-сайт или приложение.
- Ключи API используются для идентификации проекта, выполняющего вызов. Это может быть веб-сайт или приложение, которое вызывает интерфейс прикладного программирования.
Ключи интерфейса прикладного программирования гарантируют авторизацию проекта
Прежде чем выбрать наиболее подходящую схему, вам необходимо сначала понять, какие ключи аутентификации и API могут предоставить. Ключи могут обеспечивать:
- Авторизация проекта — чтобы помочь проверить, имеет ли приложение, выполняющее вызов, доступ для его вызова.Он также проверяет, включен ли API в этом проекте.
- Идентификация проекта — идентификация проекта или приложения, вызывающего API.
Обратите внимание, что ключи API не так безопасны, как токены, используемые для аутентификации. Однако они помогают идентифицировать проект или приложение, стоящее за вызовом.
Ключи генерируются в проекте, стоящем за вызовом. Это означает, что вы можете легко ограничить их использование такими средами, как приложение iOS или Android.Вы также можете использовать диапазон IP-адресов для ограничения использования.
Возможность идентифицировать проект, вызывающий вызов, означает, что ключи API могут использоваться для связывания информации об использовании с данным проектом. Ключи также позволяют ESP (Extensible Service Proxy) отклонять вызовы, поступающие от проектов, у которых нет доступа или которые не были включены в этом конкретном API.
Аутентификация пользователя
Схемы аутентификации служат двум основным целям:
- Авторизация пользователя — проверка, есть ли у пользователя, выполняющего вызов, разрешение на отправку такого рода запросов.
- Аутентификация пользователя — убедитесь, что звонящий является тем человеком, за которого он претендует.
Назначение схемы аутентификации — дать возможность идентифицировать личность вызывающего абонента. Конечная точка также может проверить токен аутентификации, чтобы убедиться, что ей предоставлено разрешение на вызов API. На основе информации, доступной в токене аутентификации, сервер API принимает окончательное решение о том, авторизовать ли этот конкретный запрос.
Чтобы получить ключ API:
- Войдите или зарегистрируйтесь в своей учетной записи RapidAPI.
- Перейдите на любую страницу документации API, выполнив поиск или щелкнув одну из коллекций на домашней странице.
- Прокрутите вниз до раздела «Параметры заголовка» консоли API.
- Ваш ключ API должен быть виден в поле «X-RapidAPI-Key».
Соответствующие статьи
FAQ
Как создать ключ API?
Чтобы получить ключ API:
- Войдите или зарегистрируйтесь в своей учетной записи RapidAPI.
- Перейдите на любую страницу документации API, выполнив поиск или щелкнув одну из коллекций на домашней странице.
- Прокрутите вниз до раздела «Параметры заголовка» консоли API.
- Ваш ключ API должен быть виден в поле «X-RapidAPI-Key».
Срок действия ключей API истекает?
Это полностью зависит от API, который вы используете. По большей части ключи API не имеют срока действия, если вы используете RapidAPI API.
Есть ли API поиска Google?
Да, совершенно точно.Посмотрите здесь.
Использование ключей API | API Адресов | Разработчики Google
В этом руководстве показано, как создавать, ограничивать и использовать ключ API для платформы Google Maps.
Прежде чем вы начнете
Прежде чем вы начнете использовать Places API, вам понадобится проект с платежным аккаунтом и API Адресов включено. Чтобы узнать больше, см. Начало работы с платформой Google Maps.
Создание ключей API
Ключ API — это уникальный идентификатор, который аутентифицирует запросы, связанные с вашим проектом, для использования и выставления счетов. У вас должен быть хотя бы один ключ API, связанный с вашим проектом.
Для создания ключа API:
Перейдите на страницу API и службы> Учетные данные .
Перейти на страницу учетных данных
- На странице Credentials щелкните Create credentials> API key .
В диалоговом окне создания ключа API отображается только что созданный ключ API. - Щелкните Close.
Новый ключ API указан на странице Учетные данные в разделе Ключи API .
(Не забудьте ограничить ключ API, прежде чем использовать его в производстве.)
Ограничение ключей API
Ограничение ключей API повышает безопасность вашего приложения, гарантируя, что только авторизованные запросы сделано с помощью вашего ключа API. Мы настоятельно рекомендуем вам следовать инструкциям по установке ограничений для ваших ключей API. Для получения дополнительной информации см. Лучшие практики API Key.
Для ограничения ключа API:
Перейдите на страницу API и службы> Учетные данные .
Перейти на страницу учетных данных
- Выберите ключ API, для которого нужно установить ограничение. Откроется страница свойств ключа API.
- В соответствии с Ограничения на ключи , установите следующие ограничения:
- Ограничения по применению:
- Чтобы принимать запросы из предоставленного вами списка IP-адресов веб-серверов, выберите IP-адресов (веб-серверы, задания cron и т. Д.) из списка Ограничения по применению .
- Укажите один адрес IPv4 или IPv6 или подсеть, используя нотацию CIDR (например, 192. 168.0.0/22). Если вам нужно ввести другую запись, новое поле появится после завершения добавления предыдущая запись.
- Нажмите Клавиша ограничения .
- Выберите Places API из Выберите API в раскрывающемся списке.
(Если API Адресов отсутствует в списке, вам необходимо включить его.)
Добавление ключа API в запрос
Вы должны включать ключ API в каждый запрос API Адресов. В следующем примере
замените YOUR_API_KEY
своим ключом API.
https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=-33.8670522,151.1957362&radius=500&types=food&name=harbour&key=YOUR_API_KEY
Устранение проблем с аутентификацией
Если ваш запрос неверен или содержит недействительную подпись, API Адресов
возвращает ошибку HTTP 403 (запрещено)
.
Для устранения неполадок с отдельными URL-адресами вы можете использовать Отладчик подписи URL. Это позволяет быстро проверить URL-адрес и подпись, сгенерированные вашим приложением.
Клиенты с премиальным планом и мигрировавшие клиенты
Клиенты премиум-плана и клиенты, которые перешли с премиум-плана на платформу Google Maps. Модель ценообразования с оплатой по мере использования позволяет использовать ключ API или идентификатор клиента для аутентификации запросов. Для получения дополнительной информации см. Обзор получения ключей API. в документации к премиум-плану.
Почему и когда использовать ключи API | Облачные конечные точки с OpenAPI
На этой странице представлена справочная информация о ключах API и аутентификации: как каждый из них используется, различия между ними и сценарии, в которых вам следует подумать об использовании ключей API.
API-ключи для проектов, аутентификация для пользователей
Cloud Endpoints обрабатывает как ключи API, так и схемы аутентификации, такие как Firebase или Auth0. Основное различие между этими двумя:
API-ключи обеспечивают авторизацию проекта
Чтобы решить, какая схема является наиболее подходящей, важно понимать какие ключи API и аутентификация могут предоставить.
Ключи API предоставляют
Идентификация проекта — Идентификация приложения или проекта который обращается к этому API
Авторизация проекта — Проверить, предоставлено ли вызывающее приложение доступ для вызова API и включил API в своем проекте
Ключи API не так безопасны, как токены аутентификации (см. Безопасность ключей API), но они идентифицируют приложение или проект, вызывающие API. Они есть генерируются в проекте, в котором осуществляется вызов, и вы можете ограничить их использование среда, такая как диапазон IP-адресов или приложение для Android или iOS.
Определив вызывающий проект, вы можете использовать ключи API, чтобы связать использование информация с этим проектом. Ключи API позволяют Расширяемый сервисный прокси (ESP) отклонять вызовы из проектов, которым не был предоставлен доступ или которые не были включены в API.Аутентификация пользователей
Напротив, схемы аутентификации обычно служат двум целям:
Схемы аутентификации обеспечивают безопасный способ идентификации вызывающего пользователя.Конечные точки также проверяют токен аутентификации, чтобы убедиться, что он имеет разрешение на вызов API. На основе этой аутентификации сервер API принимает решение об авторизации запроса.
Если вам нужна возможность идентифицировать пользователя, звонящего, см. Аутентификация пользователей.
Хотя ключи API идентифицируют вызывающий проект, они не идентифицируют вызывающий пользователь. Например, если вы создали приложение, которое вызывает API, ключ API может идентифицировать приложение, которое выполняет вызов, но не личность человека, использующего приложение.
Если вам нужен более безопасный способ ограничения того, какие проекты или услуги могут вызывать ваш API, см. Аутентификация между сервисами.
Безопасность ключей API
API-ключи обычно не считаются безопасными; они обычно доступны для клиентов, что упрощает кражу ключа API. Как только ключ украден, у него нет срока годности, поэтому его можно использовать бесконечно, если только владелец проекта отменяет или восстанавливает ключ. Пока ограничения можно установленный на ключе API смягчает это, есть лучшие подходы для авторизация.
Примеры см. Аутентификация пользователей.
Когда использовать ключи API
API может ограничивать некоторые или все свои методы, требуя ключей API. Это делает смысл это делать если:
Вы действительно хотите заблокировать анонимный трафик. Ключи API определяют трафик для производителя API, если разработчику приложения необходимо работать с производителем API, чтобы отладить проблему или показать их приложение использование.
Вы хотите контролировать количество обращений к вашему API.
Вы хотите определить шаблоны использования в трафике вашего API. Ты можешь видеть использование приложений в API и сервисы.
Вы хотите фильтровать журналы по ключу API.
Ключи API нельзя использовать для:
Идентификация отдельных пользователей — ключи API не идентифицируют пользователей, они определить проекты.
Безопасная авторизация.
Выявление создателей проекта.
Сервисная инфраструктура не предоставляет метод прямого поиска проектов по ключам API.
Как использовать ключи API
Чтобы узнать, как настроить и использовать доступ к ключу API, см. Ограничение доступа ключами API.ключей API — что такое ключ API и как они используются?
от Tiempo Development 27 апреля 2020
Что такое ключ API? Ваш бизнес виртуально работает на интерфейсах прикладного программирования (API).Они позволяют внутренним приложениям, приложениям для работы с клиентами и интеграции приложений с вашими деловыми партнерами общаться друг с другом и обмениваться данными и информацией. Все эти соединения упрощают приобретение продуктов и услуг для клиентов и повышают эффективность ваших внутренних рабочих процессов.
А, используя API, ваш бизнес может повысить ценность этих рабочих процессов за счет интеграции корпоративных систем и подключения к передовым технологиям. К ним относятся сети Интернета вещей (IoT), роботизированные системы, машинное обучение и наборы больших данных в социальных сетях.
Одним из вариантов защиты API является ключ API. Это длинная строка случайно сгенерированных символов, которая может выглядеть примерно так:
xaCGLgL.0inklc7mVLWwsAawjYr5Rx-Af50DDqtlx
Ключ состоит из кода, передаваемого между API и службами приложения. Код вызывает программы из другого приложения, а затем ключ идентифицирует конечного пользователя, разработчика кода и приложение, выполняющее вызов API.
В этом смысле ключ API действует как токен аутентификации или уникальный идентификатор.Он гарантирует авторизацию, проверяя связанные права доступа API, чтобы узнать, разрешил ли доступ приложение, выполняющее вызов.
Как используются ключи API?
Ключи APIобрабатываются конечными точками и используются с приложениями и интерфейсами веб-сайтов, которые разработчики программного обеспечения обычно называют проектами. Ключи не так безопасны, как токены аутентификации, но они обеспечивают уровень безопасности, позволяя идентифицировать проект, стоящий за вызовом.
Разработчики могут закодировать ключи API, чтобы ограничить использование проекта определенными средами или диапазоном IP-адресов.Таким образом, расширяемый прокси-сервер службы может отклонять вызовы без авторизованного доступа из определенного API.
Как ключи API аутентифицируют пользователей?
Строки ключейAPI проверяют, включен ли API в приложении, а также отслеживают и контролируют использование интерфейса. Это предотвращает злоупотребление API вредоносными ботами и другие формы кибератак.
Например, ключи проверяют авторизацию конечного пользователя, определяя, получили ли вызовы разрешение на доступ к определенной службе приложения.Это важная функция, поскольку конечные пользователи могут иметь авторизованный доступ к некоторым, но не ко всем отдельным службам в приложении.
Ключ также может аутентифицировать пользователей — удостоверяя, что звонящий действительно является тем человеком, за которого они себя выдвигают, — а не хакером, подменяющим конечного пользователя. Конечная точка также может быть аутентифицирована с помощью ключа, проверяя токен аутентификации устройства. Это подтверждает, было ли предоставлено надлежащее разрешение.
Это удобно для сервисов, к которым конечным пользователям разрешен доступ на одном из своих устройств, таких как локальный рабочий стол, но не на мобильном устройстве, подключенном к общедоступной сети Wi-Fi (если вы не используете SSL / TLS. / HTTPS).Сервер API имеет последнее слово, разрешать ли каждый запрос — как определено токеном аутентификации.
Очень важно убедиться, что вы кодируете ключи API для правильной аутентификации. Ранее в этом году журнал CISO Magazine сообщил, что Starbucks оставила ключ API в сети без защиты паролем, который мог использоваться злоумышленниками для доступа к внутренним системам и манипулирования списком авторизованных пользователей. Кроме того, ZDNet недавно сообщил, что фирма Imperva, занимающаяся кибербезопасностью, случайно открыла внутренний сервер в прошлом году, и это позволило хакеру украсть ключ API AWS.
Как получить ключ API?
Когда разработчики программного обеспечения хотят запрограммировать API для подключения одной из своих служб приложений к другой службе приложений, им необходимо запросить ключ API у владельца службы приложения, к которой они хотят подключиться. Владельцы приложений, которые делают подключения к своим службам приложений доступными для внешних разработчиков, обычно публикуют процесс получения ключа API.
В большинстве случаев у запрашивающего разработчика должен быть хотя бы один ключ API, связанный с его проектом приложения.Получить ключ можно быстро и легко, и в основном это включает в себя создание учетной записи у владельца приложения, а затем регистрацию проекта, для которого требуется ключ. Теперь остается лишь взаимодействовать с консолью, созданной владельцем приложения, и использовать раскрывающиеся меню для создания учетных данных для создания нового ключа API.
Срок действия ключей редко истекает. Но перепроверьте на случай, если владелец приложения установил требование продлевать ваш доступ к ключу, что может происходить ежегодно или, возможно, раз в два года.
Вы должны добавить к ключу ограничения приложений и HTTP, прежде чем использовать его в производстве. Ограничения приложений зависят от типа приложения и указывают, какие веб-сайты, IP-адреса или приложения могут использовать ключ API. Можно применить ограничение HTTP, чтобы разрешить конкретный URL с точным путем, например https://www.example.com/path.
При кодировании ключей API для своих приложений не забудьте предоставить им такой же уровень защиты, как имена пользователей и пароли. Ключи не должны быть жестко закодированы в репозиториях исходного кода.Это особенно важно для разработки мобильных приложений, поскольку мобильные приложения легко загружаются из издательских магазинов. Код можно напрямую деобфусцировать или перепроектировать, если разработчики не применяют меры защиты от потенциальных киберугроз.
Значение ключей API для вашего бизнеса
Ключи APIиграют ключевую роль в обеспечении правильности и авторизации соединений между службами приложений. Это включает в себя аутентификацию как конечного пользователя, так и устройства с помощью приложения для вызова другого приложения для конкретной службы.
Правильное программирование имеет решающее значение для вашего бизнеса. Ключи API помогают убедиться, что клиенты могут получить доступ к службам и данным, необходимым им для размещения заказов, но не получить доступ к какой-либо информации, которую они не имеют права видеть. То же самое и с вашими внутренними пользователями. В каждом из ваших корпоративных приложений и баз данных есть некоторые области, которые пользователи могут видеть, а другие — нет. Ключи API помогают убедиться, что они видят только то, что должны видеть.
Узнайте больше о ключах API и о том, как Tiempo API Consulting Services могут помочь вашей компании в процессе цифровой трансформации.
Видео: важность надежной стратегии API
О ключах API
Прочтите эту страницу в
английский Español Français Português Deutsch
В этой статье мы рассмотрим, что такое API, как использовать ключ API для предоставления доступа к вашей учетной записи Mailchimp и куда обращаться за поддержкой с любыми дополнительными вопросами, которые могут у вас возникнуть по API Mailchimp.
Что такое API?
API означает интерфейс прикладного программирования. Может быть полезно думать об API как о способе общения различных приложений друг с другом. Для многих пользователей основное взаимодействие с API будет осуществляться через ключи API, которые позволяют другим приложениям получать доступ к вашей учетной записи без предоставления вашего пароля.
Найдите или сгенерируйте свой ключ API
Если вы хотите настроить интеграцию со своей учетной записью Mailchimp, велики шансы, что вам потребуется сгенерировать ключ API.Пользователи с разрешениями Manager могут создавать и просматривать свои собственные ключи API. Пользователи с правами администратора также могут видеть ключи API для других пользователей учетной записи.
- Щелкните эту ссылку, чтобы перейти в раздел ключей API своей учетной записи Mailchimp: Ваши ключи API
- Скопируйте существующий ключ API или нажмите кнопку Create A Key .
- Назовите свой ключ описательно, чтобы вы знали, какое приложение использует этот ключ.
Отключить ключ API
Если вас беспокоит, что ключ API был скомпрометирован или вы больше не используете интеграцию, которая осуществляла доступ к вашей учетной записи через определенный ключ API, вы можете отключить этот ключ API.Чтобы отключить ключ API, выполните следующие действия.
- Нажмите, чтобы открыть раздел «Ключи API» вашей учетной записи.
- Найдите ключ API, который вы хотите отключить, и переключите ползунок в столбце Статус для этого ключа API.
- В модальном всплывающем окне нажмите Отключить .
Безопасность ключа API
Ключи APIпредоставляют полный доступ к вашей учетной записи Mailchimp и должны быть защищены так же, как вы защищаете свой пароль.В частности, есть несколько распространенных сценариев, которые следует учитывать при работе с ключами API.
- Дайте каждой интеграции свой собственный ключ API и присвойте каждому ключу метки, чтобы вы знали, какой ключ подходит к какому приложению. Если определенный ключ API скомпрометирован, вы можете отключить этот ключ, не отключая доступ ко всем другим вашим интеграциям.
- Будьте осторожны, чтобы не раскрывать ключ общественности (например, в скриншотах, видео или справочной документации). Помните, что размытия данных не всегда достаточно.Лучше всего использовать в графической программе функции «вырезания», чтобы полностью удалить данные.
- Из-за потенциальных рисков безопасности, связанных с раскрытием ключей API учетной записи, Mailchimp не поддерживает реализацию нашего API на стороне клиента с использованием запросов CORS или включения ключей API в мобильные приложения.
- Если необходимо предоставить общий доступ к ключу, сгенерируйте новый ключ и пометьте его соответствующим образом, чтобы при необходимости его можно было отключить. Никогда не отправляйте ключ API по электронной почте, потому что это позволит получить доступ к вашей учетной записи Mailchimp, если хакеры взломают вашу учетную запись электронной почты.
- Если вы отмените доступ пользователя к своей учетной записи Mailchimp, любые ключи API, созданные пользователем, будут удалены из вашей учетной записи.
- Доступ к каждой конечной точке определяется ролью пользователя, создавшего ключ API. Чтобы узнать больше о разрешениях на уровне пользователей, посетите Управление уровнями пользователей в своей учетной записи.
Поддержка API
Наша команда поддержки Mailchimp не обучена углубленному поиску и устранению неполадок API. Если вам нужен разработчик, который поможет вам настроить что-то с помощью API, ознакомьтесь с нашим замечательным каталогом экспертов, в котором перечислены сторонние эксперты Mailchimp, которых можно нанять для помощи.
Если вы разработчик, который хочет создать собственную интеграцию с Mailchimp, ознакомьтесь с нашей документацией по API.
ключей API
Stripe аутентифицирует ваши запросы API с помощью ключей API вашего аккаунта. Если вы не укажете свой ключ при запросе API или используете неверный или устаревший, Stripe вернет ошибку.
Каждой учетной записи предоставляются отдельные ключи для тестирования и выполнения транзакций в реальном времени. Все запросы API существуют либо в тестовом, либо в реальном режиме, и объекты — клиенты, планы, купоны и т. Д. — в одном режиме не могут управляться объектами в другом.
Также существует два типа ключей API: для публикации и секретный .
- Ключи API для публикации предназначены исключительно для идентификации вашей учетной записи в Stripe, они не являются секретными. Другими словами, их можно безопасно публиковать в таких местах, как ваш JavaScript-код Stripe.js, или в приложении для Android или iPhone.
- Секретные Ключи API должны храниться в секрете и храниться только на ваших серверах. Секретный ключ API вашей учетной записи может выполнять любой запрос API к Stripe без ограничений.
Каждая учетная запись имеет в общей сложности четыре ключа: пара ключей для публикации и секрета для тестового режима и режима реального времени.
Получение ключей API
Ключи API всегда доступны на панели инструментов. Для вашего удобства, ваши тест API ключи для вашей учетной записи являются:
Ключ | Значение |
---|---|
к опубликованию | pk_test_TYooMQauvdEDq54NiTphI7jx |
Secret | sk_test_4eC39HqLyjWDarjtT1zdp7dc |
Stripe автоматически заполняет примеры кода в нашей документации вашими тестовыми ключами API, когда вы вошли в систему — только вы можете видеть эти значения.
Используйте только свои тестовые ключи API для тестирования и разработки . Это гарантирует, что вы случайно не измените текущих клиентов или платежи.
Если у вас нет роли администратора или разработчика, у вас может не быть доступа для просмотра ключей API на панели инструментов. Свяжитесь с владельцем вашей учетной записи Stripe и попросите добавить его в команду в качестве разработчика.
Тестовый и живой режимы
Тестовый и живой режимы работают почти одинаково, с некоторыми необходимыми отличиями:
- В тестовом режиме платежи не обрабатываются сетями карт или поставщиками платежей, и может использоваться только наша тестовая платежная информация .
- Некоторые способы оплаты, использующие Источники, имеют более детализированный поток в режиме реального времени, с большим количеством шагов, требуемых, чем в тестовом режиме.
- Споры также имеют более подробный поток в режиме реального времени и более простой процесс тестирования.
- Веб-перехватчики, которые не были успешно подтверждены, повторяются три раза в течение нескольких часов (в отличие от 72 часов в режиме реального времени).
- В тестовом режиме конфиденциальные поля объекта Account не возвращаются.
Вы можете просмотреть тестовые данные, переключив на приборной панели параметр Просмотр тестовых данных .
Обеспечение безопасности ваших ключей
Ваш секретный ключ API может использоваться для выполнения любых вызовов API от имени вашей учетной записи, таких как создание списаний или выполнение возмещения. Обращайтесь со своим секретным ключом API, как с любым другим паролем. Предоставляйте доступ только тем, кому это нужно. Убедитесь, что он не используется в любой системе контроля версий, которую вы можете использовать. Управляйте доступом к своему ключу с помощью диспетчера паролей или службы управления секретами.
В режиме реального времени новые секретные ключи видны только при первом доступе к ним.После этого Dashboard редактирует ключ API. Когда ключ раскрыт, вы можете оставить заметку на панели инструментов с описанием того места в вашей системе, куда вы его скопировали. Если вы потеряете свой секретный ключ, вы не сможете восстановить его из Личного кабинета, и вам придется использовать новый ключ или создать новый.
Отображение примечания к отредактированному секретному ключу.
Ключи, созданные до введения этой функции, не скрываются автоматически при открытии, но могут быть скрыты вручную.
Скользящие ключи
Если ключ API скомпрометирован, сверните ключ на панели инструментов, чтобы заблокировать его и сгенерировать новый.
Прокрутка ключа API.
При смене ключа API вы можете сразу же заблокировать старый ключ или позволить ему работать в течение 12 часов, что даст вам время для перехода. В любом случае новый ключ можно использовать немедленно.
Ограничение доступа с помощью ограниченных ключей API
Секретные ключи API вашей учетной записи можно использовать для выполнения любого запроса API без ограничений.Для большей безопасности вы можете создавать ограниченные ключи API, которые ограничивают доступ и разрешения для различных областей данных вашей учетной записи. Они заменяют ваш секретный ключ API и должны использоваться, если вы работаете с микросервисами, которые взаимодействуют с Stripe API от вашего имени.
Ключ с ограничениями обеспечивает только минимальный уровень доступа, необходимый службе, при этом защищая данные учетной записи, в которых она не нуждается. Например, вы можете создать ограниченный ключ, который предоставляет доступ только для чтения к данным спора, а затем использовать его со службой мониторинга споров.
Если вам больше не нужен ограниченный ключ (или вы подозреваете, что он был взломан), вы можете отозвать его в любое время. Вы также можете отредактировать ключ, чтобы изменить уровень доступа.
Ключи с ограниченным доступом предназначены для снижения риска при использовании или создании микросервисов. Их нельзя использовать в качестве альтернативы ключам API вашей учетной записи при разработке интеграции Stripe — ключи с ограниченным доступом не могут взаимодействовать со многими частями API Stripe. Используйте свои тестовые ключи API во время разработки и живые ключи API, когда ваша интеграция будет запущена.
Ключи API
API означает интерфейс прикладного программирования. Вы можете думать об API как о способе взаимодействия одного приложения с другим. Чтобы вы или другие приложения могли взаимодействовать с Recurly, вам потребуется ключ API. Ключ API можно рассматривать как пароль, который Recurly использует для идентификации программы, выполняющей запрос.
Если вы хотите настроить интеграцию со своей учетной записью Recurly, велики шансы, что вам потребуется сгенерировать ключ API.Пользователи с разрешениями Manager могут создавать и просматривать свои собственные ключи API. Пользователи с правами администратора также могут видеть ключи API для других пользователей учетной записи. Ниже вы узнаете, как получить существующий ключ API или создать новый.
- Как разработчик или администратор перейдите в Интеграции> Ключи API.
- Нажмите «Сохранить изменения».
Если вы хотите отозвать ключ API, вы можете сделать это, выполнив следующие действия. Мы рекомендуем вам отозвать свой ключ API, если у вас есть основания полагать, что безопасность ключа может быть скомпрометирована.
В качестве разработчика или администратора перейдите в раздел «Разработчики»> «Ключи API».
Найдите ключ, который вы хотите отозвать.
У вас есть три варианта: отозвать ключ навсегда, немедленно восстановить ключ или заново создать ключ в течение 12 часов.
Немедленно отозвать
Если вы отзовете ключ, мы не создадим еще один ключ, и он сразу перестанет работать. Все приложения, которые имеют доступ к Recurly с помощью этого ключа, немедленно перестанут иметь доступ.
Немедленно восстановить
Если вы немедленно сгенерируете ключ, старый ключ перестанет работать, и Recurly выдаст вам новый ключ API. Все приложения, у которых есть доступ к Recurly через старый ключ, немедленно перестанут иметь доступ, и мы рекомендуем вам обновить приложения с новым ключом.
Если вам нужен ключ API в кодировке Base64, вы можете скопировать его из Recurly без необходимости конвертировать самостоятельно. Перейдите в раздел «Интеграция»> «Учетные данные API» в «Периодически» и щелкните, чтобы развернуть «Нужна помощь с использованием ключа API?».Ваш ключ API в кодировке Base64 — это символы после «Authorization: Basic»
.Восстановить через 12 часов
Если вы выберете эту опцию, старый ключ будет по-прежнему действителен в течение 12 часов, и Recurly сгенерирует новый ключ. Это даст вам время обновить приложения с помощью старого ключа до нового ключа. В течение 12-часового периода приложения, использующие старый ключ, не пострадают и смогут аутентифицироваться, как если бы ничего не изменилось. По прошествии 12 часов старый ключ перестанет работать.
Ключи APIпредоставляют полный доступ к вашей учетной записи Recurly и должны быть защищены так же, как вы защищаете свой пароль. В частности, есть несколько распространенных сценариев, которые следует учитывать при работе с ключами API.
- Дайте каждой интеграции свой собственный ключ API и присвойте каждому ключу метки, чтобы вы знали, какой ключ подходит к какому приложению. Если определенный ключ API скомпрометирован, вы можете отключить этот ключ, не отключая доступ ко всем другим вашим интеграциям.
- Будьте осторожны, чтобы не раскрывать ключ общественности (например, на снимках экрана, в видеороликах или в справочной документации).Помните, что размытия данных не всегда достаточно. Лучше всего использовать в графической программе функции «вырезания», чтобы полностью удалить данные.
- Если ключ должен быть общим, сгенерируйте новый ключ и пометьте его соответствующим образом, чтобы его можно было отключить при необходимости. Никогда не отправляйте ключ API по электронной почте, потому что он позволит получить доступ к вашей учетной записи Recurly, если хакеры взломают вашу учетную запись электронной почты.
- Если вы отмените доступ пользователя к своей учетной записи Recurly, любые ключи API, созданные пользователем, будут удалены из вашей учетной записи.
- Не встраивайте, не храните и не раскрывайте ключи API в коде на стороне клиента, включая JavaScript, мобильные приложения и собственные исполняемые файлы. Плохой субъект может декомпилировать ваше приложение и получить ваш ключ (и) API.
Если вам потребуется дополнительная поддержка, обратитесь в службу поддержки Recurly, и мы будем рады вам помочь.
.