Зарегистрируйте разработчиков приложений

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

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

Введение

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

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

Как зарегистрировать разработчиков приложений

Зарегистрируйте разработчиков приложений одним из следующих способов:

Рекомендации по управлению учетными записями разработчиков на порталах разработчиков

Apigee рекомендует управлять учетными записями разработчиков непосредственно на портале разработчиков.

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

Если вы используете портал разработчиков на базе Drupal, управление учетными записями разработчиков непосредственно на портале разработчиков дает следующие преимущества:

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

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

  • Любые изменения, внесенные в учетную запись разработчика на портале, автоматически отправляются в Edge.

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

Изучение страницы разработчиков

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

Край

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

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Опубликовать» > «Разработчики» на левой панели навигации.

Откроется страница разработчиков.

Как показано на рисунке, страница «Разработчики» позволяет вам:

Классический Edge (частное облако)

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

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите «Опубликовать» > «Разработчики» на верхней панели навигации.

Откроется страница разработчиков.

Добавление разработчика

Чтобы добавить разработчика:

  1. Откройте страницу разработчиков.
  2. Нажмите + Разработчик .
  3. Введите данные разработчика, включая имя, фамилию, адрес электронной почты и имя пользователя.
  4. Нажмите Создать .

Просмотр и редактирование сведений о разработчике

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

Чтобы просмотреть и изменить сведения о разработчике:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, которого вы хотите просмотреть и отредактировать, чтобы открыть сведения о разработчике.
  3. В разделе «Подробности» отображается следующая информация. При необходимости отредактируйте данные разработчика.
    Деталь Описание
    Подробности Имя и фамилия разработчика, имя пользователя и адрес электронной почты; статус и продолжительность регистрации; и идентификатор разработчика.
    Чтобы изменить сведения о разработчике, щелкните любое из следующих полей:
    • Имя
    • Фамилия
    • Электронная почта
    • Имя пользователя
    Измените содержимое и нажмите Enter, чтобы подтвердить изменение.
    Пользовательские атрибуты Пользовательские атрибуты, определенные для разработчика. При необходимости настройте пользовательские атрибуты. Для получения дополнительной информации см.:
    Приложения Приложения, зарегистрированные разработчиком. См. Регистрация приложений .
  4. Активируйте или деактивируйте разработчика в поле Статус.
    Дополнительную информацию см. в разделе Активация и деактивация разработчика .

При использовании Apigee Edge для публичного облака Edge сохраняет следующие объекты в кэше в течение как минимум 180 секунд после доступа к объектам.

  • Токены доступа OAuth. Это означает, что отозванный токен может оставаться успешным в течение трех минут, пока не истечет срок его кэша.
  • Объекты службы управления ключами (KMS) (приложения, разработчики, продукты API).
  • Пользовательские атрибуты токенов OAuth и объектов KMS.

Управление пользовательскими атрибутами для разработчика

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

Чтобы управлять пользовательскими атрибутами:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, для которого вы хотите управлять настраиваемыми атрибутами, чтобы открыть сведения о разработчике.
  3. Нажмите + в разделе «Пользовательские атрибуты».
  4. Введите имя и значение атрибута.
  5. Нажмите .
  6. Чтобы удалить пользовательский атрибут, наведите курсор на атрибут и нажмите кнопку в меню действий.

Активация и деактивация разработчика

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

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

Чтобы активировать или деактивировать разработчика:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, которого вы хотите активировать или деактивировать, чтобы открыть сведения о разработчике.
  3. В разделе «Сведения» установите в поле «Статус» значение «Активно» или «Неактивно» по мере необходимости.
  4. Повторите действия, если разработчик работает в нескольких организациях.

Экспорт данных публикации

Экспортируйте следующие данные публикации в виде файла со значениями, разделенными запятыми (CSV):

  • Подробности о разработчике
  • Сведения о разработчике, приложении и API-продукте

Чтобы экспортировать данные публикации:

  1. Откройте страницу разработчиков.
  2. Нажмите Экспортировать CSV...
  3. В раскрывающемся списке выберите «Разработчики» или «Разработчики, приложения и продукты» .

Выбранные данные публикации загружаются в виде файла CSV.

Удаление разработчика

Чтобы удалить разработчика:

  1. Откройте страницу разработчиков.
  2. Наведите курсор на строку разработчика, которого вы хотите удалить, чтобы отобразить меню действий.
  3. Нажмите .
  4. Нажмите «Удалить», чтобы подтвердить удаление.

Синхронизация разработчиков приложений между порталом и Edge

Если вы используете портал разработчиков на базе Drupal для публикации своих API, изменения, внесенные разработчиками приложений с помощью Edge, не распространяются на портал. Вы должны войти на портал как администратор портала и синхронизировать портал с Edge, чтобы эти изменения отобразились на портале.

Чтобы синхронизировать портал разработчика с разработчиками приложений, определенными в Edge, обратитесь к следующим разделам:

Группировка разработчиков в компании

При монетизации компания представляет собой совокупность разработчиков, управляемых как единое целое. Компания может представлять собой любую группу, подходящую для вашей организации, например бизнес-подразделение, линейку продуктов или подразделение. Группировка разработчиков в компании полезна, когда вам необходимо объединить нескольких разработчиков в одну юридическую единицу. Например, вам может потребоваться настроить разные компании для выставления счетов. Однако разработчики в вашей организации не обязательно должны быть связаны с компанией. Обратите внимание, что разработчик всегда представляет собой единую сущность, уникально идентифицируемую элементом электронной почты. Если разработчик является частью компании, вы увидите название компании на странице «Разработчики».

Дополнительную информацию об управлении компаниями и разработчиками для монетизации см. в разделе Управление компаниями и разработчиками .

Настройка атрибутов монетизации

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

Имя поля Имя пользовательского атрибута Описание
Адрес MINT_DEVELOPER_ADDRESS

Адрес разработчика, включая следующие поля: адрес (строки 1 и 2), город, штат, почтовый индекс и страна.

Платежный профиль MINT_BILLING_PROFILE

Платежный цикл для вашей организации. Допустимые значения включают в себя:

  • PRORATED : выставление счетов основано на количестве дней использования продукта API в календарном месяце.
  • CALENDAR_MONTH : счета производятся ежемесячно.
Тип биллинга MINT_BILLING_TYPE

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

  • ПРЕДОПЛАТА : разработчик вносит предоплату за использование продукта API. Средства списываются с баланса разработчика при использовании продукта API. Разработчик должен поддерживать предоплаченный баланс, достаточный для приобретения продукта API.
  • ПОСТОПЛАТА : разработчику ежемесячно выставляется счет (через счет) за использование продуктов API. Разработчик платит за использование продуктов API на условиях оплаты, установленных планами, включенными в счет.
  • ОБА : Поддерживает любой тип выставления счетов. По умолчанию ПРЕДОПЛАТА.

См. раздел Настройка типов выставления счетов по предоплате и постоплате с помощью API .

Категория MINT_DEVELOPER_CATEGORY Категория разработчика, в которую вы хотите добавить разработчика. Категория разработчиков – это группа разработчиков или компаний со схожими характеристиками. Дополнительные сведения см. в разделе Управление категориями разработчиков .
Идентификатор компании MINT_COMPANY_ID Идентификатор компании, если применимо. Дополнительную информацию см. в разделе Группировка разработчиков по компаниям .
Тип разработчика MINT_DEVELOPER_TYPE Это свойство не используется Apigee.

Тип разработчика. Допустимые значения: TRUSTED или UNTRUSTED

Брокер MINT_IS_BROKER Флаг, указывающий, основан ли доход на нетто.
Юридическое название MINT_DEVELOPER_LEGAL_NAME Официальное имя разработчика, которое будет использоваться во всех отчетах.
Примечание . Этот атрибут является обязательным, если разработчик не входит в группу компаний и хочет подписаться на опубликованный тарифный план.
Самовыставление счетов MINT_HAS_SELF_BILLING Флаг, указывающий, включены ли счета-фактуры с самостоятельным выставлением счетов. Если этот параметр включен ( true ), при монетизации вместо отчета о доле дохода создается счет для самостоятельного выставления счетов. Счет-фактура для самостоятельного выставления счетов — это финансовый документ, в котором указана сумма, причитающаяся застройщику. Он выступает в качестве счета-фактуры поставщику API от имени разработчика.
Номер подтверждения освобождения от налога MINT_TAX_EXEMPT_AUTH_NO Номер государственного освобождения от налогов, если применимо.
Налоговая ставка MINT_APPROX_TAX_RATE Примерная ставка налога для застройщика. Укажите десятичное значение с максимальным количеством 3 символов до десятичной точки и 4 символов после десятичной точки.

Управление разработчиками с помощью API

Управляйте разработчиками с помощью API-интерфейсов разработчика .

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

,

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

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

Введение

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

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

Как зарегистрировать разработчиков приложений

Зарегистрируйте разработчиков приложений одним из следующих способов:

Рекомендации по управлению учетными записями разработчиков на порталах разработчиков

Apigee рекомендует управлять учетными записями разработчиков непосредственно на портале разработчиков.

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

Если вы используете портал разработчиков на базе Drupal, управление учетными записями разработчиков непосредственно на портале разработчиков дает следующие преимущества:

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

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

  • Любые изменения, внесенные в учетную запись разработчика на портале, автоматически отправляются в Edge.

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

Изучение страницы разработчиков

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

Край

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

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Опубликовать» > «Разработчики» на левой панели навигации.

Откроется страница разработчиков.

Как показано на рисунке, страница «Разработчики» позволяет вам:

Классический Edge (частное облако)

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

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите «Опубликовать» > «Разработчики» на верхней панели навигации.

Откроется страница разработчиков.

Добавление разработчика

Чтобы добавить разработчика:

  1. Откройте страницу разработчиков.
  2. Нажмите + Разработчик .
  3. Введите данные разработчика, включая имя, фамилию, адрес электронной почты и имя пользователя.
  4. Нажмите Создать .

Просмотр и редактирование сведений о разработчике

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

Чтобы просмотреть и изменить сведения о разработчике:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, которого вы хотите просмотреть и отредактировать, чтобы открыть сведения о разработчике.
  3. В разделе «Подробности» отображается следующая информация. При необходимости отредактируйте данные разработчика.
    Деталь Описание
    Подробности Имя и фамилия разработчика, имя пользователя и адрес электронной почты; статус и продолжительность регистрации; и идентификатор разработчика.
    Чтобы изменить сведения о разработчике, щелкните любое из следующих полей:
    • Имя
    • Фамилия
    • Электронная почта
    • Имя пользователя
    Измените содержимое и нажмите Enter, чтобы подтвердить изменение.
    Пользовательские атрибуты Пользовательские атрибуты, определенные для разработчика. При необходимости настройте пользовательские атрибуты. Для получения дополнительной информации см.:
    Приложения Приложения, зарегистрированные разработчиком. См. Регистрация приложений .
  4. Активируйте или деактивируйте разработчика в поле Статус.
    Дополнительную информацию см. в разделе Активация и деактивация разработчика .

При использовании Apigee Edge для публичного облака Edge сохраняет следующие объекты в кэше в течение как минимум 180 секунд после доступа к объектам.

  • Токены доступа OAuth. Это означает, что отозванный токен может оставаться успешным в течение трех минут, пока не истечет срок его кэша.
  • Объекты службы управления ключами (KMS) (приложения, разработчики, продукты API).
  • Пользовательские атрибуты токенов OAuth и объектов KMS.

Управление пользовательскими атрибутами для разработчика

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

Чтобы управлять пользовательскими атрибутами:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, для которого вы хотите управлять настраиваемыми атрибутами, чтобы открыть сведения о разработчике.
  3. Нажмите + в разделе «Пользовательские атрибуты».
  4. Введите имя и значение атрибута.
  5. Нажмите .
  6. Чтобы удалить пользовательский атрибут, наведите курсор на атрибут и нажмите в меню действий.

Активация и деактивация разработчика

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

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

Чтобы активировать или деактивировать разработчика:

  1. Откройте страницу разработчиков.
  2. Щелкните строку разработчика, которого вы хотите активировать или деактивировать, чтобы открыть сведения о разработчике.
  3. В разделе «Сведения» установите в поле «Статус» значение «Активно» или «Неактивно» по мере необходимости.
  4. Повторите действия, если разработчик работает в нескольких организациях.

Экспорт данных публикации

Экспортируйте следующие данные публикации в виде файла со значениями, разделенными запятыми (CSV):

  • Подробности о разработчике
  • Сведения о разработчике, приложении и API-продукте

Чтобы экспортировать данные публикации:

  1. Откройте страницу разработчиков.
  2. Нажмите Экспортировать CSV...
  3. В раскрывающемся списке выберите «Разработчики» или «Разработчики, приложения и продукты» .

Выбранные данные публикации загружаются в виде файла CSV.

Удаление разработчика

Чтобы удалить разработчика:

  1. Откройте страницу разработчиков.
  2. Наведите курсор на строку разработчика, которого вы хотите удалить, чтобы отобразить меню действий.
  3. Нажмите .
  4. Нажмите «Удалить», чтобы подтвердить удаление.

Синхронизация разработчиков приложений между порталом и Edge

Если вы используете портал разработчиков на базе Drupal для публикации своих API, изменения, внесенные разработчиками приложений с помощью Edge, не распространяются на портал. Вы должны войти на портал как администратор портала и синхронизировать портал с Edge, чтобы эти изменения отобразились на портале.

Чтобы синхронизировать ваш портал разработчика с разработчиками приложений, определенными в Edge, обратитесь к следующим разделам:

Группировка разработчиков в компании

При монетизации компания представляет собой совокупность разработчиков, управляемых как единое целое. Компания может представлять собой любую группу, подходящую для вашей организации, например бизнес-подразделение, линейку продуктов или подразделение. Группировка разработчиков в компании полезна, когда вам нужно, чтобы несколько разработчиков были объединены в одну юридическую единицу. Например, вам может потребоваться настроить разные компании для выставления счетов. Однако разработчики в вашей организации не обязательно должны быть связаны с компанией. Обратите внимание, что разработчик всегда представляет собой единую сущность, уникально идентифицируемую элементом электронной почты. Если разработчик является частью компании, вы увидите название компании на странице «Разработчики».

Дополнительную информацию об управлении компаниями и разработчиками для монетизации см. в разделе Управление компаниями и разработчиками .

Настройка атрибутов монетизации

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

Имя поля Имя пользовательского атрибута Описание
Адрес MINT_DEVELOPER_ADDRESS

Адрес разработчика, включая следующие поля: адрес (строки 1 и 2), город, штат, почтовый индекс и страна.

Платежный профиль MINT_BILLING_PROFILE

Платежный цикл для вашей организации. Допустимые значения включают в себя:

  • PRORATED : выставление счетов основано на количестве дней использования продукта API в календарном месяце.
  • CALENDAR_MONTH : счета производятся ежемесячно.
Тип платежа MINT_BILLING_TYPE

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

  • ПРЕДОПЛАТА : разработчик вносит предоплату за использование продукта API. Средства списываются с баланса разработчика при использовании продукта API. Разработчик должен поддерживать предоплаченный баланс, достаточный для приобретения продукта API.
  • ПОСТОПЛАТА : разработчику ежемесячно выставляется счет (через счет) за использование продуктов API. Разработчик платит за использование продуктов API на условиях оплаты, установленных планами, включенными в счет.
  • ОБА : Поддерживает любой тип выставления счетов. По умолчанию ПРЕДОПЛАТА.

См. раздел Настройка типов выставления счетов по предоплате и постоплате с помощью API .

Категория MINT_DEVELOPER_CATEGORY Категория разработчика, в которую вы хотите добавить разработчика. Категория разработчиков – это группа разработчиков или компаний со схожими характеристиками. Дополнительные сведения см. в разделе Управление категориями разработчиков .
Идентификатор компании MINT_COMPANY_ID Идентификатор компании, если применимо. Дополнительную информацию см. в разделе Группировка разработчиков по компаниям .
Тип разработчика MINT_DEVELOPER_TYPE Это свойство не используется Apigee.

Тип разработчика. Допустимые значения: TRUSTED или UNTRUSTED

Брокер MINT_IS_BROKER Флаг, указывающий, основан ли доход на нетто.
Юридическое название MINT_DEVELOPER_LEGAL_NAME Официальное имя разработчика, которое будет использоваться во всех отчетах.
Примечание . Этот атрибут является обязательным, если разработчик не входит в группу компаний и хочет подписаться на опубликованный тарифный план.
Самовыставление счетов MINT_HAS_SELF_BILLING Флаг, указывающий, включены ли счета-фактуры с самостоятельным выставлением счетов. Если этот параметр включен ( true ), при монетизации вместо отчета о доле дохода создается счет для самостоятельного выставления счетов. Счет-фактура для самостоятельного выставления счетов — это финансовый документ, в котором указана сумма, причитающаяся застройщику. Он выступает в качестве счета-фактуры поставщику API от имени разработчика.
Номер подтверждения освобождения от налога MINT_TAX_EXEMPT_AUTH_NO Номер государственного освобождения от налогов, если применимо.
Налоговая ставка MINT_APPROX_TAX_RATE Примерная ставка налога для застройщика. Укажите десятичное значение с максимальным количеством 3 символов до десятичной точки и 4 символов после десятичной точки.

Управление разработчиками с помощью API

Управляйте разработчиками с помощью API-интерфейсов разработчика .

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