Рекомендации по использованию API Postman

Postman значительно расширяет возможности тестирования и понимания API продавцов, предоставляя удобный интерфейс для создания, отправки и анализа HTTP-запросов. Вы можете легко создавать и изменять различные вызовы API (GET, POST, PUT, DELETE) к разным конечным точкам, настраивая параметры, заголовки и тела запросов для имитации реальных сценариев.

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

Обзор

Для использования коллекции MAPI Postman в вашем экземпляре Postman необходимо выполнить несколько шагов для предварительной настройки среды . Ниже приведено пошаговое руководство по этому процессу.

Для получения более подробной информации о платформе см. описание Postman .

1. Настройка учетной записи службы

Вы получите serviceAccountKey и api_key.

  1. Подробные инструкции см. в разделе «Как использовать учетную запись службы для доступа к API».
  2. В вашем проекте Google Cloud > Учетные данные > Создать учетные данные > Учетная запись службы
  3. Заполните форму и нажмите «Создать и продолжить».
  4. Выберите роль «Владелец» и нажмите «Продолжить».
  5. Нажмите «Готово».
  6. Чтобы загрузить JSON-ключ, выполните следующие шаги:
    1. Щелкните по адресу электронной почты только что созданной учетной записи службы (например, {ВАША_УЧЕТНАЯ_ЗАПИСЬ_СЛУЖБЫ}@{СЛУЧАЙНЫЙ_ДОМЕН}.gserviceaccount.com).
    2. Перейдите во вкладку «Клавиши» .
    3. Нажмите «Добавить ключ» > «Создать ключ».
    4. Выберите JSON и нажмите «Создать» , чтобы загрузить JSON-файл.

ВНИМАНИЕ: Вы можете скачать ключ только один раз . Если вы его потеряете, вам нужно будет создать новый ключ и удалить этот.

  1. Открытый торговый центр
  2. В разделе «Настройки» > «Доступ и службы» нажмите «Люди и доступ».
  3. Нажмите «Добавить пользователя» и используйте идентификатор учетной записи службы в качестве адреса электронной почты для нового пользователя.

2. Почтальон подготовился

  1. Скачайте шаблон среды Postman в формате JSON.
  2. Загрузите коллекцию MAPI Postman в формате JSON.
  3. Войдите в Postman или создайте новую учетную запись.
  4. Импорт шаблона среды Postman
    1. Скопируйте весь JSON-код в Environment > MyAccount > serviceAccountKey
    2. Скопируйте свой закрытый ключ из JSON-файла в раздел Environment > MyAccount > api_key вашей коллекции.
  5. Импорт MAPI Postman Collection JSON
  6. Выберите среду в правом верхнем углу.

3. Регистрация разработчика

Свяжите свою учетную запись Merchant Center с проектом Google Cloud, зарегистрировавшись в качестве разработчика. Пользователи с ролью разработчика API будут получать уведомления об API, включая обязательные объявления о сервисе, опросы для разработчиков и информацию о возможностях трудоустройства.

  1. Откройте Postman > Коллекции > Официальный API для продавцов
  2. Откройте accounts_v1 > accounts > accounts.developerRegistration > registerGcp
  3. Замените заполнитель {account} в пути на свой идентификатор MC.
  4. Замените заполнитель {email} в тексте сообщения своим адресом электронной почты.
  5. Нажмите «Отправить» , чтобы завершить регистрацию.
  6. Если все сделано правильно, вы получите подтверждающий JSON-ответ примерно такого вида: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Протестируйте API продавца в Postman.

  1. Откройте Postman > Коллекции > Официальный API продавца > accounts_v1 > accounts > список
  2. Нажмите «Отправить»
  3. Если все сделано правильно, вы получите подтверждающий JSON-ответ примерно такого вида: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }