API Yampi
Search
K
Comment on page

Usuários

Dados do usuário logado

POST https://api.dooki.com.br/v2/auth/me
Includes disponíveis: merchants, merchant.config, group
Payload com os dados do usuário logado
{
"data": {
"id": 17,
"active": true,
"name": "Lucas Colette",
"email": "[email protected]",
"avatar_url": "https://secure.gravatar.com/avatar/6bc484627a4c1cdb5e10c01f1c2b49b6?s=80&r=g&d=identicon",
"roles": [],
"permissions": [],
"merchants": {
"data": [
{
"id": 29,
"active": true,
"corporate": true,
"alias": "alias",
"domain": "domain.com.br"
}
],
},
}
}

Listar todos usuários de uma loja

GET https://api.dooki.com.br/v2/{alias}/users

Excluir usuário de uma loja

DELETE https://api.dooki.com.br/v2/{alias}/users/{id}

Exclusão de usuário em massa

DELETE https://api.dooki.com.br/v2/{alias}/users/batch-detach

Listar atividades de um usuário

GET https://api.dooki.com.br/v2/{alias}/users/{id}/activities

Permissões de usuários

Listar permissões

GET https://api.dooki.com.br/v2/{alias}/users/permissions
Response de permissões
{
"data": [
{
"id": 1,
"name": "view_catalog",
"translated_name": "Visualizar catálogo"
},
{
"id": 2,
"name": "manage_catalog",
"translated_name": "Gerenciar catálogo"
},
// ...
]
}

Grupos de usuários

Listar grupos

GET https://api.dooki.com.br/v2/{alias}/users/groups
Request
{
"name": "Administrador test",
"permissions_ids": [1, 2, 3, 4, 5]
}
Response
{
"data": {
"id": 1,
"name": "Administrador test",
"permissions": {
"data": [
{
"id": 1,
"name": "view_catalog",
"translated_name": "Visualizar catálogo"
},
{
"id": 2,
"name": "manage_catalog",
"translated_name": "Gerenciar catálogo"
},
// ...
]
}
}
}

Criar grupo

POST https://api.dooki.com.br/v2/{alias}/users/groups
Parâmetro
Tipo
Obrigatório
Descrição
name
string
Sim
Nome do grupo.
permissions_ids
array
Sim
Array com os IDS das permissões do grupo.

Visualizar grupo

GET https://api.dooki.com.br/v2/{alias}/users/groups/{id}

Atualizar grupo

PUT https://api.dooki.com.br/v2/{alias}/users/groups/{id}

Excluir grupo

DELETE https://api.dooki.com.br/v2/{alias}/users/groups/{id}

Convites de usuários

Convidar um usuário para participar de uma loja

POST https://api.dooki.com.br/v2/{alias}/users/invite
O usuário convidado receberá um e-mail com um link para aceitar o convite. Caso ele não possua uma conta, ele deverá criar uma.
Request para enviar um convite
{
"email": "[email protected]",
"group_id": 1
}
Response de um convite
{
"data": {
"id": 10,
"group_id": 1,
"accepted": false,
"token": "408f1f50-f575-11e7-9fcf-8bc3b49ec7cb",
"accepted_at": null,
"email": "[email protected]",
}
}
Parâmetro
Tipo
Obrigatório
Descrição
email
string
Sim
E-mail do usuário que será convidado.
group_id
int
Sim
ID do grupo de acesso que ele fará parte.

Listar convites de usuários

GET https://api.dooki.com.br/v2/{alias}/users/invites

Novo convite de usuários

POST https://api.dooki.com.br/v2/{alias}/users/invites

Visualizar convite de usuário

GET https://api.dooki.com.br/v2/{alias}/users/invites/{id}

Reenviar um convite de usuário

GET https://api.dooki.com.br/v2/{alias}/users/invites/{id}/resend