top of page

Esta API fornece endpoints para consulta, criação, edição e deleção de estruturas hierárquicas.
Uma estrutura hierárquica representa a forma como a organização se divide em níveis, áreas e vínculos de responsabilidade de pessoas.

Início > Hierarquias

Versão: 2.0

Hierarquias

GET  Hierarquias

Endpoint responsável por consultar grupos de hierarquias, com a opção de filtrar pelo email do usuário ou o id do grupo.

Endpoint GET

URL

Parâmetros da requisição

Informe os parâmetros abaixo para realizar a consulta de clientes.​

​​

email: Email do usuário responsável.

   Tipo: String.

grupo_id: Id do grupo.

   Tipo: Integer.

Exemplo: 

curl --location 'https://yandeh-seller-integration.yandeh.com.br/grupo-hierarquia?email=1&grupo_id=50' \
--header 'Authorization: Bearer ...' \

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "sucesso",
   "data": [
       {
           "id": "1",
           "nome": "Gestor",
           "grupo_pai": null,
           "descricao": "Gestor",
           "usuario_responsavel_id": 10,
           "usuario_responsavel_nome": "User10",
           "usuario_responsavel_email": "exemplo@email.com.br",
           "usuario_responsavel_contribui_metrica": false,
           "entidade": [
               {
                   "id": 11,
                   "nome": "User11",
                   "email": "exemplo@email.com",
                   "contribui_metrica": true
               }
           ],
           "level": 0,
           "grupos": [

               {
                  "id": "2",
                  "nome": "Supervisor",
                  "grupo_pai": 1,
                  "descricao": "Supervisor",
                  "usuario_responsavel_id": 12,
                  "usuario_responsavel_nome": "User12",
                  "usuario_responsavel_email": "exemplo@email.com",
                  "usuario_responsavel_contribui_metrica": true,
                  "entidade": [
                      {
                          "id": 13,
                          "nome": "User13",
                          "email": "exemplo@email.com",
                          "contribui_metrica": true
                      }
                  ],
                  "level": 1,
                  "sub_grupos": []
              }

           ],
       }
   ]
}

Elementos da Resposta

mensagem: Mensagem de retorno da requisição.
    Tipo: String

data: Lista de grupos retornados.
    Tipo: Array de Objetos

id: Identificador único do grupo hierárquico.
    Tipo: String

nome: Nome do grupo.
    Tipo: String

grupo_pai: ID do grupo pai.
    Tipo: String ou Null

descricao: Descrição do grupo.
    Tipo: String

usuario_responsavel_id: Identificador único do usuário responsável.
    Tipo: Integer

usuario_responsavel_nome: Nome do usuário responsável.
    Tipo: String

usuario_responsavel_email: E-mail do usuário responsável.
    Tipo: String

usuario_responsavel_contribui_metrica: Indica se o usuário responsável contribui para métricas.
    Tipo: Boolean

entidade: Lista de entidades associadas ao grupo.
    Tipo: Array de Objetos

id: Identificador único da entidade.
    Tipo: Integer

nome: Nome da entidade.
    Tipo: String

email: E-mail da entidade.
    Tipo: String

contribui_metrica: Indica se a entidade contribui para métricas.
    Tipo: Boolean

level: Nível hierárquico do grupo, iniciando em 0 para o grupo pai e 1 para grupos associados.
    Tipo: Integer

grupos: Lista de grupos associados ao grupo.
    Tipo: Array de Objetos

sub_grupos: Lista de subgrupos. Eles existem no nível 2 para cima.

    Tipo: Array

POST Hierarquias

Endpoint responsável pelo cadastro de novos grupos hierárquicos.

Endpoint POST

URL

Sintaxe da Requisição

  1. Tipo de requisição: POST .

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

    Envio do  JSON como exemplo abaixo:

[
   {
       "nome": "Gerente",
       "descricao": "Gerente de vendas 1",
       "grupo_pai": null,
       "email_usuario_responsavel": "exemplo@email.com"
   }
]

Exemplo: 

curl --location 'https://yandeh-seller-integration.yandeh.com.br/grupo-hierarquia' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
   {
       "nome": "Gerente",
       "descricao": "Gerente de vendas 1",
       "grupo_pai": null,
       "email_usuario_responsavel": "exemplo@email.com"
   }
]'

Elementos da Requisição

nome: Nome do grupo.

  • Campo obrigatório.

   Tipo: String.

descricao: Descrição do grupo.

  • Campo obrigatório.

   Tipo: String.

grupo_pai: id do grupo pai (necessário apenas para grupos filhos).​

   Tipo Integer ou Null.
email_usuario_responsavel: Email do usuário responsável pelo grupo hierárquico.
  Tipo: String.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

    "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [
       {
           "index": 0,
           "item": {
               "nome": "Gerente",
               "descricao": "Gerente de vendas 1",
               "grupo_pai": null,
               "entidade": "USUARIO"
           }
       }
   ],
   "erros": []
}

207 Multi-Status - Caso o usuário responsável enviado seja inválido, o cadastro ocorrerá sem o responsável pelo grupo.

{
   "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [
       {
           "index": 0,
           "item": {
               "nome": "Gerente",
               "descricao": "Gerente de vendas 1",
               "grupo_pai": null,
               "email_usuario_responsavel": "exemplo@email.com",
               "entidade": "USUARIO"
           },
           "mensagem": "Grupo criado com sucesso, porém o usuário responsável não foi encontrado na base de dados"
       }
   ],
   "erros": []
}

Respostas para erros

400 Bad request - Tentativa de envio de hierarquias já cadastradas

{
   "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [],
   "erros": [
       {
           "index": 0,
           "item": {
               "nome": "Escritório",
               "descricao": "Escritório...",
               "grupo_pai": 11,
               "entidade": "USUARIO",
               "email_usuario_responsavel": "exemplo@email.com"
           },
           "mensagem": "Grupo com as informações inseridas já existe (ID 12)"
       }
   ]
}

POST Entidade

Endpoint responsável pelo cadastro de novas entidades (usuários) em grupos de hierarquias.

Endpoint POST

URL

Sintaxe da Requisição

  1. Tipo de requisição: POST .

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

    Envio do  JSON como exemplo abaixo:

[ 

    {   

        "grupo_id": 12,   

        "entidade_email": "exemplo@email.com",

        "contribui_metrica": true

    }

]

Exemplo: 

curl --location 'https://yandeh-seller-integration.yandeh.com.br/entidade' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
  {
    "grupo_id": 12,
    "entidade_email": "exemplo@email.com",

    "contribui_metrica": true
  }
]'

Elementos da Requisição

grupo_id: Id da hierarquia em que a entidade será inserida.

  • Campo obrigatório.

   Tipo: Integer.

entidade_email: Email do usuário entidade.

  • Campo obrigatório.

   Tipo: String.

contribui_metrica: Indica se a entidade contribui para métricas.​

   Tipo: String.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [
       {
           "index": 0,
           "item": {
               "grupo_id": 12,
               "entidade_email": "exemplo@email.com"
           },
           "mensagem": "Entidade criada com sucesso"
       }
   ],
   "erros": []
}

Respostas para erros

400 Bad Request - Em caso de grupo entidade não criado préviamente:

    "mensagem": "Erro ao criar entidades, verifique os dados informados",
   "total": 1,
   "sucessos": [],
   "erros": [
       {
           "index": 0,
           "item": {
               "grupo_id": 12,
               "entidade_email": "exemplo@email.com"
           },
           "mensagem": "Não foi encontrada a relação entre o grupo e o usuário informado"
       }
   ]
}

PUT Hierarquias

Endpoint responsável pela atualização de grupos de hierarquias.

Endpoint PUT

URL

Sintaxe da Requisição

  1. Tipo de requisição: PUT.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

    Envio do  JSON como exemplo abaixo:

[
   {
       "grupo_id": 1,
       "nome": "Grupo 2",
       "descricao": "Grupo 2...",
       "grupo_pai": 12,

       "email_usuario_responsavel": "exemplo@email.com"
   }
]

Exemplo: 

curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/grupo-hierarquia' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
  {
      "grupo_id": 1,
      "nome": "Grupo 2",
      "descricao": "Grupo 2...",
      "grupo_pai": 12,

      "email_usuario_responsavel": "exemplo@email.com"
  }
]'

Elementos da Requisição

grupo_id: Id do grupo que será atualizado.

  • Campo obrigatório.

   Tipo: Integer.

nome: Nome do grupo.​

  • Campo obrigatório.

   Tipo: String.

descricao: Descrição do grupo.​

   Tipo: String.

grupo_pai: id do grupo pai.​

   Tipo Integer.

email_usuario_responsavel: Email do usuário responsável pelo grupo hierárquico.

  • Campo obrigatório.

   Tipo: String.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [
       {
           "index": 0,
           "item": {
               "grupo_id": 1,
               "nome": "Grupo 2",
               "descricao": "Grupo 2...",
               "grupo_pai": 12,
               "email_usuario_responsavel": "exemplo@email.com"
           },
           "mensagem": "Hierarquia atualizada com sucesso"
       }
   ],
   "erros": []
}

Respostas para erros

400 Bad Request - Em caso de omissão de um campo obrigatório:

{
   "mensagem": "Erro ao atualizar hierarquias, verifique os dados informados",
   "total": 1,
   "sucessos": [],
   "erros": [
       {
           "index": 0,
           "item": {
               "grupo_id": 373,
               "nome": "ESCRITORIO",
               "descricao": "",
               "grupo_pai": 77
           },
           "mensagem": "Email do usuário responsável não informado"
       }
   ]
}

PUT Entidade

Endpoint responsável pela atualização das entidades.

Endpoint PUT

URL

Sintaxe da Requisição

  1. Tipo de requisição: PUT.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

    Envio do  JSON como exemplo abaixo:

[
   {
       "grupo_id": 12,
       "contribui_metrica": true,
       "entidade_email": "exemplo@email.com.br"
   }
]

Exemplo: 

curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/entidade' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
   {
       "grupo_id": 12,
       "contribui_metrica": true,
       "entidade_email": "exemplo@email.com.br"
   }
]'

Elementos da Requisição

grupo_id: Id do grupo.

  • Campo obrigatório.

   Tipo Integer.

contribui_metrica: Booleano para identificar usuários que contribuem com a métrica.​

   Tipo: Boleano.
entidade_email: Email do usuário entidade.

  • Campo obrigatório.

   Tipo: String.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "Processamento concluído",
   "total": 1,
   "sucessos": [
       {
           "index": 0,
           "item": {
               "grupo_id": 12,
               "contribui_metrica": true,
               "entidade_email": "exemplo@email.com",
               "grupoEntidadeId": 123
           },
           "mensagem": "Entidade atualizada com sucesso"
       }
   ],
   "erros": []
}

Respostas para erros

400 Bad Request - Em caso de omissão de um campo obrigatório:

{
   "mensagem": "Erro ao atualizar entidades, verifique os dados informados",
   "total": 1,
   "sucessos": [],
   "erros": [
       {
           "index": 0,
           "item": {
               "grupo_id": 373,
               "contribui_metrica": true
           },
           "mensagem": "Email do usuário responsável não informado"
       }
   ]
}

DELETE Hierarquias

Endpoint responsável pela deleção de hierarquias.

Endpoint DELETE

URL

Sintaxe da Requisição

  1. Tipo de requisição: DELETE.

  2. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  3. Corpo da requisição:

    Envio do  JSON como exemplo abaixo:

{
   "grupo_ids": [
       11
   ]
}

Exemplo: 

curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/grupo-hierarquia' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '{
  "grupo_ids": [
      11
  ]
}'

Elementos da Requisição

grupo_ids: Ids dos grupos que serão deletados.

  • Campo obrigatório.

   Tipo Lista de Integer.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "Todos os grupos foram excluídos com sucesso",
   "detalhes": {
       "processados": 1,
       "sucessos": 1,
       "falhas": 0
   }
}

Respostas para erros

400 Bad Request - Em caso de envio de grupos inválidos:

{
   "mensagem": "Erro ao processar exclusão de grupos hierarquia",
   "detalhes": {
       "processados": 1,
       "sucessos": 0,
       "falhas": 1,
       "erros": [
           {
               "grupo_id": 1,
               "statusCode": 404,
               "erro": "Grupo com o identificador 1 não encontrado para o fornecedor 282"
           }
       ]
   }
}

400 Bad Request - Em caso de envio vazio:

{
   "mensagem": "É obrigatório pelo menos um grupo_id para deletar"
}

DELETE Entidade

Endpoint responsável pela deleção de entidades (usuários) nas hierarquias.

Endpoint DELETE

URL

Parâmetros da requisição

Informe os parâmetros abaixo para realizar a consulta de clientes.​

​​​

entidade_email: Email da entidade a ser excluída da hierarquia.

   Tipo: String.

grupo_id: Id do grupo.

   Tipo: Integer.

Exemplo: 

curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/entidade?entidade_email='exemplo@email.com'&grupo_id=11' \--header 'Authorization: Bearer ...' \

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os dados

com status code 200. Exemplo de retorno:

{
   "mensagem": "Entidade hierarquia excluída com sucesso"
}

Respostas para erros

400 Bad Request - Em caso de envio de grupos ou emails inválidos:

{
   "mensagem": "Entidade não encontrada para o email: silvanodaniel6@gmail.com"
}

bottom of page