API-интерфейс Commerce Portal можно использовать для получения информации о пользователях, договорах, заказах с ежемесячным выставлением счета (MBO) и сделках с поставщиками услуг. Для взаимодействия с API-интерфейсом Commerce Portal необходимо создать маркер API-интерфейса на Commerce Portal и обменять его на маркер предъявителя.

Дополнительные сведения об операциях, которые можно выполнять с помощью API-интерфейса Commerce Portal, см. в справке и документации по API-интерфейсу агрегатора Commerce Portal.

Как создать маркер API-интерфейса?

Пользователь с ролью Администратор создает маркер API-интерфейса в настройках профиля.

  1. На панели инструментов Commerce Portal разверните раскрывающееся меню рядом с именем пользователя и нажмите кнопку Профиль.
  2. Для создания маркера API-интерфейса щелкните СОЗДАТЬ МАРКЕР.
  3. Выберите дату окончания срока действия маркера и нажмите СОЗДАТЬ МАРКЕР.
  4. Скопируйте или сохраните созданный маркер и нажмите ПРОДОЛЖИТЬ.

Как обменять маркер API-интерфейса на маркер предъявителя?

Прежде чем направлять разрешенные запросы API-интерфейсу Commerce Portal, необходимо обменять маркер API-интерфейса на маркер предъявителя.

Вызовите API-интерфейс проверки подлинности и обменяйте маркер API-интерфейса на маркер предъявителя.

curl https://vcp.vmware.com/api/commerce/v1/auth \
-H 'Content-Type:application/json' \
-d '{"type":"UserToken","userToken":"yourAPIToken"}'

В ответе возвращается маркер предъявителя в параметре "accessToken".

{
 "tokenType":"bearer",
 "accessToken":"eyJhbGciOiJIUzUxMiJ9.
eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjZmYWExZDM2LTE2NTUtNGY4Ny04ZWE3LWU0NGI0ZTM1MzQ2\
 MSIsImlhdCI6MTY1NDgzODc2NSwiZXhwIjoxNjU0ODQwNTY1fQ.
W9UCFRPNLpJK1JHKiBSODdjdyRqSBhq6jq7y5JkccmV5Gsw34zXrwiZcFECmhorvk5XW4Ow-1e0zGSR_if8AEQ",
 "expiresIn":1800
}

Как использовать маркер предъявителя в последующих запросах API-интерфейса?

Получив маркер предъявителя, установите его в качестве заголовка "Authorization" HTTP для авторизации последующих запросов API-интерфейса. Правильный формат для использования: "Authorization: Bearer your_accessToken".

В нижеприведенном примере показано, как маркер предъявителя используется в запросе GET. 
curl https://vcp.vmware.com/api/aggregator/v1/contracts \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjZmYWExZDM2LTE2NTUtNGY4Ny04ZWE3LWU0NGI0ZTM1MzQ2MSIsImlhdCI6MTY1NDgzODc2NSwiZXhwIjoxNjU0ODQwNTY1fQ.W9UCFRPNLpJK1JHKiBSODdjdyRqSBhq6jq7y5JkccmV5Gsw34zXrwiZcFECmhorvk5XW4Ow-1e0zGSR_if8AEQ"