Endpoints responsáveis pelo cadastro de usuários indicados pelo fornecedor para
acesso à plataforma Yandeh Abastece Shop por um login externo.
Início > Usuários
Versão: 2.0
API de Cadastro de usuários
GET Usuários
Endpoint responsável pela consulta dos usuários cadastrados com acesso à plataforma Yandeh.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos usuários.
email : E-mail do usuário que será consultado.
-
Parâmetro não obrigatório.
pagina: Página a ser exibida.
-
Parâmetro não obrigatório.
-
Default página 1.
por_pagina: Quantidade de usuários a serem exibidos por página.
-
Parâmetro não obrigatório.
-
Default 10 registros por página.
-
Máximo de 100 registros po página.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/usuarios?pagina=1&por_pagina=100&email=teste20441@gmail.com' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"mensagem": "Busca realizada com sucesso",
"data": [
{
"name": "a",
"email": "teste20441@gmail.com",
"tipo": "cliente"
}
],
"total": "1"
}
Elementos da Resposta
name: Nome do usuário cadastrado.
Tipo: String
email: Email do usuário cadastrado
Tipo: String.
id: Perfil do usuário cadastrado.
Tipo: String.
POST Usuários
Endpoint responsável pelo cadastro de usuários.
Endpoint POST
URL:
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
Sintaxe da Requisição
[
{
"email": "teste@gmail.com",
"nome": "Teste usuário",
"telefone": "34999221199",
"codigo_vendedor": "",
"clientes": [
{
"cnpj_cpf": "72695968000100"
},
{
"cnpj_cpf": "04039000000107"
}
]
}
]
Exemplo :
curl --location --request POST 'https://yandeh-seller-integration.yandeh.com.br/usuarios' \
--data-raw '[
{
"email": "Teste12345@gmail.com",
"nome": "Teste usuários",
"telefone": "34955221100",
"codigo_vendedor": "",
"clientes": [
{
"cnpj_cpf": "72695968000100"
},
{
"cnpj_cpf": "04000770000107"
}
]
}
Elementos da Requisição
email: E-mail do usuário a ser criado com acesso autorizado à plataforma.
-
Campo obrigatório
Tipo: String
nome: Nome do usuário.
-
Campo obrigatório
Tipo: String
telefone: Telefone do usuário.
Tipo: String.
codigo_vendedor: Código do vendedor, caso o usuário seja perfil vendedor.
Tipo: String.
Clientes:
cnpj_cpf: CNPJ das lojas ou CPF dos clientes que o usuário terá acesso à plataforma.
Tipo: String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"message": "[POST - USUARIOS] - Processamento concluído. 1 sucessos, 0 erros",
"data": {
"processados": 1,
"sucessos": [
{
"indice": 0,
"email": "teste12345@gmail.com",
"status": 200
}
],
"erros": []
}
}
Resposta com erros
Status code 400: Bad Request
Campos obrigatórios não informados no payload: Nome
{
"message": "Erro ao cadastrar usuário e vínculo de cliente.",
"detalhes": "Nenhum dado usuário válido",
"data": {
"invalidos": [
{
"indice": 0,
"dados": {
"email": "teste12345@gmail.com",
"telefone": "34955221100",
"codigo_vendedor": "",
"clientes": [
{
"cnpj_cpf": "04039770000107"
}
]
},
"detalhe": "Nome obrigatório não fornecido"
}
]
}
}
Campos obrigatórios não informados no payload: Email
{
"message": "Erro ao cadastrar usuário e vínculo de cliente.",
"detalhes": "Nenhum dado usuário válido",
"data": {
"invalidos": [
{
"indice": 0,
"dados": {
"nome": "Teste 1234",
"telefone": "34955221100",
"codigo_vendedor": "",
"clientes": [
{
"cnpj_cpf": "04039770000107"
}
]
},
"detalhe": "Email obrigatório não fornecido"
}
]
}
}
Status code 400: Bad Request
Usuário já cadastrado e cnpj do cliente inválido (CNPJ do cliente não encontrado(cadastrado) na Yandeh):
{
"message": "[POST - USUARIOS] - Processamento concluído. 0 sucessos, 1 erros",
"data": {
"processados": 1,
"sucessos": [],
"erros": [
{
"indice": 0,
"email": "teste123456@gmail.com",
"mensagem": "Já existe usuário cadastrado com esse email"
}
],
"clientesNãoAtualizados": [
{
"email": "teste123456@gmail.com",
"clientesInvalidos": [
{
"cnpj_cpf": "04000000000107",
"detalhes": "Sem permissão para adicionar/atualizar este cliente."
}
]
}
]
}
}
Status code 400: Bad Request
Usuário já cadastrado:
{
"message": "[POST - USUARIOS] - Processamento concluído. 0 sucessos, 1 erros",
"data": {
"processados": 1,
"sucessos": [],
"erros": [
{
"indice": 0,
"email": "teste123456@gmail.com",
"mensagem": "Já existe usuário cadastrado com esse email"
}
]
}
}
Status code 200 : Ok
Usuário cadastrado com sucesso, porém CNPJ do cliente é inválido (CNPJ do cliente não encontrado(cadastrado) na Yandeh)
{
"message": "[POST - USUARIOS] - Processamento concluído. 1 sucessos, 0 erros",
"data": {
"processados": 1,
"sucessos": [
{
"indice": 0,
"email": "teste123456@gmail.com",
"status": 200
}
],
"erros": [],
"clientesNãoAtualizados": [
{
"email": "teste123456@gmail.com",
"clientesInvalidos": [
{
"cnpj_cpf": "04000070000107",
"detalhes": "Sem permissão para adicionar/atualizar este cliente."
}
]
}
]
}
}
PUT Usuários
Endpoint responsável por atualizar os dados de usuários já cadastrados.
Endpoint PUT
URL:
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
-
OBS: No payload, o campo 'acao' deve conter o valor 'adicionar' para incluir um novo cliente ou 'remover' para excluir um cliente existente
-
[
{
"email": "teste123456@gmail.com",
"nome": "Teste Usuário",
"clientes": [
{
"cnpj_cpf": "04039770000107",
"acao": "adicionar"
}
]
}
]
Exemplo:
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/usuarios' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
{
"email": "teste123456@gmail.com",
"nome": "Teste Usuário",
"clientes": [
{
"cnpj_cpf": "04039770000107",
"acao": "adicionar"
}
]
}
]'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"message": "[PUT - USUARIOS] - Processamento concluído. 1 sucessos, 0 erros",
"data": {
"processados": 1,
"sucessos": [
{
"indice": 0,
"email": "teste123456@gmail.com",
"status": "sucesso"
}
],
"erros": []
}
}
Elementos da Resposta
processados: Quantidade de registros tratados durante a operação.
Tipo: Integer
Sucesso: Lista dos registros que foram atualizados.
indice: Indica a posição do registro que foi atualizado.
Tipo: Integer.
email: Email do usuário atualizado com sucesso.
Tipo: Integer.
status: Situação final da operação realizada.
Tipo: String.
Erros: Lista de registros que não foram atualizados, acompanhados dos respectivos motivos de erro
Resposta com erros
Status code 400:
Usuário não encontrado:
{
"message": "[PUT - USUARIOS] - Processamento concluído. 0 sucessos, 1 erros",
"data": {
"processados": 1,
"sucessos": [],
"erros": [
{
"indice": 0,
"email": "teste123456@gmail.com",
"status": "erro",
"erro": "Usuário não encontrado"
}
]
}
}
DELETE Usuários
Endpoint responsável por remover um usuário cadastrado.
Endpoint DELETE
URL:
Parâmetros da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Authorization: Bearer <token>
-
-
Parâmetro:
Informe o e-mail do usuário a ser deletado nos parâmetros da requisição.
Exemplo:
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/usuarios?email=teste_1234@gmail.com' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará status code 200.
Exemplo de retorno:
{
"message": "[DELETE - USUARIOS] - Usuário deletado com sucesso"
}
Resposta com erros
Status code 400: Bad Request
Email não encontrado:
GET White List
Endpoint responsável por verificar se os usuários cadastrados estão autorizados a acessar a plataforma Yandeh pelo login externo.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos usuários.
email : E-mail do usuário que será consultado.
-
Parâmetro obrigatório.
Exemplo:
curl --location '
https://yandeh-seller-integration.yandeh.com.br/clientes-externos?email=teste@gmail.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará status code 200.
Exemplo de retorno:
{
"userAllowedExternalLogin": true,
"userData": {
"email": "email=teste@gmail.com",
"telefone": null,
"whatsapp": null,
"profile": "cliente",
"nome": "Teste"
}
}
Elementos da Resposta
userAllowedExternalLogin: Campo que sinaliza se o usuário está autorizado a efetuar login por meio de sistemas externos.
True: Autorizado / False: Não autorizado
Tipo: booleano
email: Email do usuário cadastrado
Tipo: String.
telefone: Telefone do usuário cadastrado.
Tipo: String
whatsapp: Whatsapp do usuário cadastrado.
Tipo: String
profile: Perfil do usuário cadastrado.
Tipo: String.
nome: Nome do usuário cadastrado.
Tipo: String
Resposta com erros
Status code 200: OK
Email do usuário informado não encontrado:
{ "userAllowedExternalLogin": false, "userData": {} }
Status code 400: Bad Request
Campo obrigatório email não informado nos parâmetros: