Grupos de credencial de marketplace
Visão Geral
Os grupos de credenciais de marketplace, permitem a Uappi 3 se conectar e interagir com marketplaces. Através deles é possível informar as credenciais necessárias para usar as APIs dos marketplaces além de configurar certos aspectos de como a integração irá se comportar.
Entidades Envolvidas
Política comercial
Ao criar um grupo de credencial, é de extrema importância escolher corretamente sua política comercial, pois será através dela que vamos obter dados de produtos como: preços, URIs, descrições, etc.Listagem de grupos de credenciais de marketplace
/marketplace/credentials
Listagem de grupos de credenciais
Descrição
Endpoint responsável por listar todas os grupos de credenciais de marketplace criadas na loja atual.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Campos Disponíveis (fields)
| Campo | Descrição |
|---|---|
| marketplace | Retorna informações do marketplace associado a credencial. |
| credentials | Retorna os itens de credencial de cada grupo contendo seus valores, tipos, e data de crição/atualização. |
Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID da credencial de marketplace. |
| name | string | Nome da credencial de marketplace. |
| marketplaceId | integer | ID do marketplace. |
| tradePolicyId | integer | ID da política comercial na credencial de marketplace. |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | ID da credencial de marketplace. |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/marketplaces/credentials \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json' \5 --data '{6 "fields": [7 "marketplace",8 "credentials"9 ],10 "order": [],11 "condition": {12 "type": "AND",13 "conditions": []14 }15}'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "registers": [5 {6 "id": 2,7 "storeId": 1,8 "marketplaceId": 1,9 "tradePolicyId": 3,10 "name": "Uappi Connect",11 "marketplace": {12 "id": 1,13 "name": "Uappi Hub",14 "code": "uappi-hub"15 },16 "credentials": [17 {18 "credentialCode": "api-key",19 "type": "string",20 "value": "apikey",21 "createdAt": "2026-01-20 12:44:13",22 "updatedAt": "2026-02-12 12:20:41"23 },24 {25 "credentialCode": "secret-key",26 "type": "string",27 "value": "secretKey",28 "createdAt": "2026-01-20 12:44:13",29 "updatedAt": "2026-02-04 12:52:51"30 },31 {32 "credentialCode": "simple-attribute-ids",33 "type": "array",34 "value": [35 1,36 2,37 3,38 4039 ],40 "createdAt": "2026-02-04 12:52:51",41 "updatedAt": "2026-02-06 12:25:59"42 },43 {44 "credentialCode": "unique-attribute-ids",45 "type": "array",46 "value": [47 39,48 4149 ],50 "createdAt": "2026-01-30 13:08:11",51 "updatedAt": "2026-02-06 12:25:59"52 }53 ]54 }55 ],56 "pagination": {57 "limit": 10,58 "offset": 0,59 "pages": 1,60 "registers": 161 }62 }63}Criação de grupo de credenciais de marketplace
/marketplace/credentials
Criação de grupo de credenciais de marketplace
Descrição
Endpoint responsável por cadastra um grupo de credenciais de marketplace específicando sua política comercial de atuação e seus itens de credencial.
⚠️ Obtendo os itens de credencial
Para obter os itens de credencial que devem ser enviados nessa requisição, consulte a sessão: listagem de itens de credencial de marketplace.Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de corpo
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| marketplaceId | integer | Sim | ID do marketplace desejado para o novo grupo de credenciais. |
| tradePolicyId | integer | Sim | ID da política comercial de atuação do novo grupo de credenciais. |
| name | string | Sim | Nome do novo grupo de credenciais. |
| credentials | object | Sim | Objeto dinâmico contendo os itens de credenciais e seus valores. |
Exemplo de Requisição
1curl --request POST \2 --url {{MAIN_URL}}/marketplaces/credentials \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json' \5 --data '{6 "marketplaceId": 1,7 "tradePolicyId": 3,8 "name": "Uappi Connect",9 "credentials": {10 "apiKey": "apiKey",11 "secretKey": "secretKey",12 "unique-attribute-ids": [13 39,14 4115 ],16 "simple-attribute-ids": [17 1,18 2,19 3,20 4021 ]22 }23}'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "id": 2,5 "storeId": 1,6 "marketplaceId": 1,7 "tradePolicyId": 3,8 "name": "Uappi Connect",9 "marketplace": {10 "id": 1,11 "name": "Uappi Hub",12 "code": "uappi-hub"13 },14 "credentials": [15 {16 "credentialCode": "api-key",17 "type": "string",18 "value": "apikey",19 "createdAt": "2026-01-20 12:44:13",20 "updatedAt": "2026-02-12 12:20:41"21 },22 {23 "credentialCode": "secret-key",24 "type": "string",25 "value": "secretKey",26 "createdAt": "2026-01-20 12:44:13",27 "updatedAt": "2026-02-04 12:52:51"28 },29 {30 "credentialCode": "simple-attribute-ids",31 "type": "array",32 "value": [33 1,34 2,35 3,36 4037 ],38 "createdAt": "2026-02-04 12:52:51",39 "updatedAt": "2026-02-06 12:25:59"40 },41 {42 "credentialCode": "unique-attribute-ids",43 "type": "array",44 "value": [45 39,46 4147 ],48 "createdAt": "2026-01-30 13:08:11",49 "updatedAt": "2026-02-06 12:25:59"50 }51 ]52 }53}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_INTEGRATION_MARKETPLACE_NOT_FOUND | 404 | O markeplace solicitado não foi encontrado. |
| UAPPI_CORE_INVALID_TRADE_POLICY_ID | 400 | A política comercial solicitada não existe ou não pode ser utilizada pelo usuário atual. |
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_IS_REQUIRED | 400 | Um item de credencial obrigatório não foi informado. |
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_TYPE_IS_INVALID | 400 | Um item de credencial foi informado com a tipagem incorreta. |
Atualização de grupo de credenciais de marketplace
/marketplace/credentials/{marketplaceStoreCredencialId}
Atualização de grupo de credenciais de marketplace
Descrição
Endpoint responsável por atualizar um grupo de credenciais de marketplace específicando uma nova política comercial de atuação e valores de itens de credencial atualizados.
⚠️ Obtendo os itens de credencial
Para obter os itens de credencial que devem ser enviados nessa requisição, consulte a sessão: listagem de itens de credencial de marketplace.Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
marketplaceStoreCredentialId | integer | ID do grupo de credencial de marktplace sendo atualizado. |
Parâmetros de corpo
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| tradePolicyId | integer | Sim | ID da política comercial de atuação do grupo de credenciais. |
| name | string | Sim | Nome do grupo de credenciais. |
| credentials | object | Sim | Objeto dinâmico contendo os itens de credenciais e seus valores. |
Exemplo de Requisição
1curl --request PUT \2 --url {{MAIN_URL}}/marketplaces/credentials/2 \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json' \5 --data '{6 "tradePolicyId": 3,7 "name": "Uappi Connect",8 "credentials": {9 "api-key": "apiKey",10 "secret-key": "apiSecret",11 "unique-attribute-ids": [12 39,13 4114 ],15 "simple-attribute-ids": [16 1,17 2,18 3,19 4020 ]21 }22}'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "id": 2,5 "storeId": 1,6 "marketplaceId": 1,7 "tradePolicyId": 3,8 "name": "Uappi Connect",9 "marketplace": {10 "id": 1,11 "name": "Uappi Hub",12 "code": "uappi-hub"13 },14 "credentials": [15 {16 "credentialCode": "api-key",17 "type": "string",18 "value": "apikey",19 "createdAt": "2026-01-20 12:44:13",20 "updatedAt": "2026-02-12 12:20:41"21 },22 {23 "credentialCode": "secret-key",24 "type": "string",25 "value": "secretKey",26 "createdAt": "2026-01-20 12:44:13",27 "updatedAt": "2026-02-04 12:52:51"28 },29 {30 "credentialCode": "simple-attribute-ids",31 "type": "array",32 "value": [33 1,34 2,35 3,36 4037 ],38 "createdAt": "2026-02-04 12:52:51",39 "updatedAt": "2026-02-06 12:25:59"40 },41 {42 "credentialCode": "unique-attribute-ids",43 "type": "array",44 "value": [45 39,46 4147 ],48 "createdAt": "2026-01-30 13:08:11",49 "updatedAt": "2026-02-06 12:25:59"50 }51 ]52 }53}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND | 404 | O grupo de credencial de marketplace não existe ou não foi encontrado. |
| UAPPI_CORE_INVALID_TRADE_POLICY_ID | 400 | A política comercial solicitada não existe ou não pode ser utilizada pelo usuário atual. |
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_IS_REQUIRED | 400 | Um item de credencial obrigatório não foi informado. |
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_TYPE_IS_INVALID | 400 | Um item de credencial foi informado com a tipagem incorreta. |
Remoção de grupo de credenciais de marketplace
/marketplace/credentials/{marketplaceStoreCredencialId}
Remoção de grupo de credenciais de marketplace
Descrição
Endpoint responsável por remover um grupo de credenciais de marketplace. É muito importante notar que os mapeamentos, filas e itens de credencial também serão removidos com essa ação.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
marketplaceStoreCredentialId | integer | ID do grupo de credencial de marktplace sendo removido. |
Exemplo de Requisição
1curl --request DELETE \2 --url {{MAIN_URL}}/marketplaces/credentials/2 \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json'✅ Resposta de Sucesso
1{2 "status": true,3 "data": true4}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND | 404 | O grupo de credencial de marketplace não existe ou não foi encontrado. |
Listagem de itens de credencial de marketplace
/marketplace/{marketplaceId}/credentials
Listagem de itens de credencial de marketplace
Descrição
Endpoint responsável por listar todos os itens necessários para criação de um grupo de credencial de marketplace. Esse endpoint também retorna o tipo (campo type), valor padrão (campo default), e possíveis valores para configuração de cada item (campo enum).
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
marketplaceId | integer | ID do marketplace desejado |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/marketplaces/1/credentials \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json'✅ Resposta de Sucesso
1{2 "status": true,3 "data": [4 {5 "code": "api-key",6 "title": "apiKey",7 "type": "string",8 "default": "",9 "enum": [],10 "mapKey": "",11 "mapValue": ""12 },13 {14 "code": "secret-key",15 "title": "secretKey",16 "type": "string",17 "default": "",18 "enum": [],19 "mapKey": "",20 "mapValue": ""21 },22 {23 "code": "unique-attribute-ids",24 "title": "Unique Attribute",25 "type": "array",26 "default": [],27 "enum": [],28 "mapKey": "",29 "mapValue": ""30 },31 {32 "code": "simple-attribute-ids",33 "title": "Simple Attribute",34 "type": "array",35 "default": [],36 "enum": [],37 "mapKey": "",38 "mapValue": ""39 }40 ]41}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_INTEGRATION_MARKETPLACE_NOT_FOUND | 404 | O markeplace solicitado não foi encontrado. |
Teste de conexão do grupo de credenciais de marketplace
/marketplace/credentials/{marketplaceStoreCredencialId}/test-connection
Teste de conexão do grupo de credenciais de marketplace
Descrição
Após a crição e do grupo de credencial com seus devidos itens configurados, é possível usar este endpoint para efetuar um teste de conexão com a API do marketplace.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros de rota
| Parâmetro | Tipo | Descrição |
|---|---|---|
marketplaceStoreCredentialId | integer | ID do grupo de credencial de marktplace. |
Exemplo de Requisição
1curl --request POST \2 --url {{MAIN_URL}}/marketplaces/credentials/2/test-connection \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json'✅ Resposta de Sucesso
1{2 "status": true,3 "data": true4}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_INTEGRATION_MARKETPLACE_CREDENTIAL_NOT_FOUND | 404 | O grupo de credencial de marketplace não existe ou não foi encontrado. |
| UAPPI_EXTERNAL_MARKETPLACE_TEST_FAIL | 400 | O teste de credencial falhou. |