Migrar o gerenciamento de usuários e acesso

Na API Content for Shopping, você gerenciava os usuários e os direitos de acesso deles com um campo no recurso Account. A API Merchant substitui isso pelo recurso dedicado chamado User e pelos métodos correspondentes (create, delete, get, list, path). Para mais informações, consulte Controlar o acesso à sua conta.

principais diferenças

Em comparação com a API Content for Shopping, a API Merchant oferece as seguintes vantagens para o gerenciamento de usuários:

• Recurso dedicado: oferece uma maneira mais granular e direta de controlar quem pode acessar sua conta do Merchant Center e o que essas pessoas podem fazer.
• Nomes de recursos RESTful: na API Merchant, identifique os recursos User por um nome de recurso completo, por exemplo, accounts/12345/users/example@example.com.
• Alias me: você pode usar o alias me em vez de um endereço de e-mail no nome do recurso para se referir ao usuário autenticado, por exemplo, accounts/12345/users/me.
• Direitos de acesso consolidados: a API Merchant consolida campos de acesso booleano da API Content (por exemplo, admin, reportingManager) em um único campo access_rights repetível.
• Convite e verificação de usuários: a API Merchant apresenta um estado explícito do usuário (PENDING ou VERIFIED). Ao criar um usuário, ele fica no estado PENDING até aceitar o convite. Isso fornece visibilidade da API ao status do usuário, que não estava disponível na API Content for Shopping. Adicionar ## Solicitações

A API Merchant usa os seguintes URLs de solicitação para gerenciar usuários:

• GET /accounts/v1/accounts/{account}/users/{email}
• GET /accounts/v1/accounts/{account}/users
• POST /accounts/v1/accounts/{account}/users
• PATCH /accounts/v1/accounts/{account}/users/{email}
• DELETE /accounts/v1/accounts/{account}/users/{email}

A tabela a seguir compara os URLs de solicitação entre a API Content for Shopping e a API Merchant.

Descrição da solicitação	API Content for Shopping	API Merchant
Receber usuários de uma conta	GET {api_version}/{merchantId}/accounts/{accountId}	GET {api_version}/accounts/{account}/users
Criar um usuário	PATCH {api_version}/{merchantId}/accounts/{accountId}	POST {api_version}/accounts/{account}/users
Atualizar um usuário	PATCH {api_version}/{merchantId}/accounts/{accountId}	PATCH {api_version}/accounts/{account}/users/{email}
Excluir um usuário	PATCH {api_version}/{merchantId}/accounts/{accountId}	DELETE {api_version}/accounts/{account}/users/{email}

Identificadores

A tabela a seguir compara os identificadores usados em solicitações entre a API Content for Shopping e a API Merchant.

Descrição do identificador	API Content for Shopping	API Merchant
Identificador da conta	accountId	account em accounts/{account}
Identificador do usuário	email_address no objeto AccountUser	email em accounts/{account}/users/{email}

Métodos

A tabela a seguir compara os métodos entre a API Content for Shopping e a API Merchant.

API Content for Shopping	API Merchant	Disponibilidade e observações
accounts.update	users.create	Cria um novo usuário para uma conta.
accounts.get	users.get	Recupera um único usuário.
accounts.get	users.list	Lista todos os usuários de uma conta.
accounts.update	users.update	Atualiza os direitos de acesso de um usuário.
accounts.update	users.delete	Exclui um usuário de uma conta.

Mudanças detalhadas nos campos

Atualize seu uso de campos da seguinte maneira:

API Content for Shopping	API Merchant	Descrição
users (AccountUser repetido)	users (User repetido)	O recurso User agora é um recurso de nível superior com serviço próprio.
AccountUser.email_address	CreateUserRequest.user_id e parte de User.name	O endereço de e-mail do usuário agora faz parte do nome do recurso. Especifique no campo user_id durante a criação.
AccountUser.admin	access_rights: "ADMIN"	A API Merchant substitui o campo booleano admin pelo valor ADMIN na enumeração access_rights.
AccountUser.order_manager, AccountUser.payments_manager, AccountUser.payments_analyst	access_rights: "STANDARD"	A API Merchant substitui essas funções pelo direito de acesso STANDARD.
AccountUser.reporting_manager	access_rights: "PERFORMANCE_REPORTING"	O papel reporting_manager agora é o direito de acesso PERFORMANCE_REPORTING.
AccountUser.read_only	access_rights: "READ_ONLY"	O papel read_only agora é o direito de acesso READ_ONLY.
Indisponível	User.name	Contém o nome completo do recurso do usuário, por exemplo, accounts/{account}/users/{email}.
Indisponível	User.state	Indica o status do convite do usuário, PENDING ou VERIFIED.