Руководство по интеграции

Получить закрытый ключ

Использование интерфейса адаптации

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

Создать учетную запись службы

Генерация ключа вручную

Если вышеуказанный интерфейс не работает, попробуйте сделать следующее:

  1. Перейдите в Google Cloud Console .
  2. Выберите проект, с помощью которого будет осуществляться доступ к API.
  3. В меню IAM и администрирование слева найдите учетные записи служб и создайте новую учетную запись службы, которая будет владельцем проекта.
  4. После создания учетной записи службы вы должны получить закрытый ключ.

Белый список учетных записей службы

После создания учетной записи службы:

  1. Свяжитесь с командой GTAF по адресу mdp-support@google.com , используя аккаунт Google, принадлежащий владельцу проекта. Мы добавим ваш аккаунт Google в белый список для доступа к конечным точкам API Mobile Data Plan Sharing.
  2. Свяжите учётную запись сервиса с оператором на портале Google ISP . Оператор может установить эту связь, перейдя в раздел «Доступ к API» .

Включить библиотеку

После внесения в белый список:

  1. Посетите Google Cloud Console .
  2. Убедитесь, что вы выбрали правильный проект в раскрывающемся списке в верхней строке меню.
  3. Включить API совместного использования мобильных тарифных планов в библиотеке API .
  4. Включите API совместного использования мобильных тарифных планов Preprod в библиотеке API .

Тестовый доступ к API

Чтобы проверить доступ к методам Google:

  1. Установить oauth2l .
  2. Получите токен доступа для своей учетной записи службы следующим образом. your-service-account-key-file.json — это файл ключа вашей учетной записи службы.

    > oauth2l fetch --json your-service-account-key-file.json dataplansharing
    

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

  3. Выполните тестовые вызовы следующим образом. YOUR-ASN должен быть одним из номеров ASN, которые вы отправили нам при настройке GTAF в процессе интеграции. ACCESS-TOKEN-OBTAINED — это вывод указанной выше команды oauth2l fetch . PLAN_STATUS — это тело запроса PlanStatus , которое вы хотите отправить в GTAF.

    > url_domain="mobiledataplansharing.googleapis.com"
    > url_path="v1/operators/YOUR-ASN/clients/mobiledataplan/users/USER_KEY/planStatus"
    > curl -H "Content-Type: application/json" \
           -d 'PLAN_STATUS' \
           -X POST "https://$url_domain/$url_path?access_token=ACCESS-TOKEN-OBTAINED"
    

Программные вызовы API

Следуйте инструкциям , чтобы выполнить авторизованные вызовы методов на стороне Google со следующей областью действия OAuth:

https://www.googleapis.com/auth/dataplansharing

Разделение права собственности на проект

Хотя первоначальная настройка предполагает наличие одного аккаунта Google, рекомендуется предоставить права владения проектом группе авторизованных пользователей. В консоли Google Cloud Console в меню «IAM и администрирование» можно добавить новых участников (включая аккаунты групп Google), которые станут владельцами проекта.