Membros e identidade visual - Base de conhecimento

Dictionaries

Lista de fusos horários

GET {{baseHost}}/v1/dictionaries/timezones

Retorna a lista de fusos horários IANA aceitos pela API (para agendamentos, analytics e afins).

O exemplo abaixo está reduzido. O endpoint devolve todos os fusos horários que aceita, cada um com os nomes localizados em en e ru.

Responses

{ "data": [  {   "name": "America/Detroit",   "en": "America/Detroit",   "ru": "Америка/Детройт",   "abbr": "EST",   "offset": -18000  },  {   "name": "Africa/Conakry",   "en": "Africa/Conakry",   "ru": "Африка/Конакри",   "abbr": "GMT",   "offset": 0  },  {   "name": "Europe/Athens",   "en": "Europe/Athens",   "ru": "Европа/Афины",   "abbr": "EET",   "offset": 7200  },  {   "name": "Africa/Nairobi",   "en": "Africa/Nairobi",   "ru": "Африка/Найроби",   "abbr": "EAT",   "offset": 10800  },  {   "name": "Asia/Colombo",   "en": "Asia/Colombo",   "ru": "Азия/Коломбо",   "abbr": "+0530",   "offset": 19800  },  {   "name": "Pacific/Majuro",   "en": "Pacific/Majuro",   "ru": "Океания/Маджуро",   "abbr": "+12",   "offset": 43200  } ]}

{
 "data": [
  {
   "name": "America/Detroit",
   "en": "America/Detroit",
   "ru": "Америка/Детройт",
   "abbr": "EST",
   "offset": -18000
  },
  {
   "name": "Africa/Conakry",
   "en": "Africa/Conakry",
   "ru": "Африка/Конакри",
   "abbr": "GMT",
   "offset": 0
  },
  {
   "name": "Europe/Athens",
   "en": "Europe/Athens",
   "ru": "Европа/Афины",
   "abbr": "EET",
   "offset": 7200
  },
  {
   "name": "Africa/Nairobi",
   "en": "Africa/Nairobi",
   "ru": "Африка/Найроби",
   "abbr": "EAT",
   "offset": 10800
  },
  {
   "name": "Asia/Colombo",
   "en": "Asia/Colombo",
   "ru": "Азия/Коломбо",
   "abbr": "+0530",
   "offset": 19800
  },
  {
   "name": "Pacific/Majuro",
   "en": "Pacific/Majuro",
   "ru": "Океания/Маджуро",
   "abbr": "+12",
   "offset": 43200
  }
 ]
}

curl -X GET \  '{{baseHost}}/v1/dictionaries/timezones' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/dictionaries/timezones' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

User/avatar

Exibir avatar

GET {{baseHost}}/v1/user/avatar/:avatar_id

Retorna os bytes da imagem do avatar.

curl -X GET \  '{{baseHost}}/v1/user/avatar/:avatar_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/user/avatar/:avatar_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Avatars

Definir avatar

POST {{baseHost}}/v1/avatar

Envia uma imagem de avatar para o workspace ou o usuário atual. Substitui o avatar que já existir.

Responses

{  "data": {    "id": "uFVdjPmQr9nPBhVodLVyEF",    "email": "user@example.com",    "full_name": "User updated1",    "auto": false,    "password_digest": "",    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",    "reset_password_token": "0000001111111111111111",    "language": "EN",    "system": false,    "confirmed_at": "2020-06-05T10:39:52.30272Z",    "created_at": "2020-06-04T21:08:35.432107Z",    "updated_at": "2020-08-27T12:36:36.580037Z",    "deleted_at": null  }}

{
  "data": {
    "id": "uFVdjPmQr9nPBhVodLVyEF",
    "email": "user@example.com",
    "full_name": "User updated1",
    "auto": false,
    "password_digest": "",
    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",
    "reset_password_token": "0000001111111111111111",
    "language": "EN",
    "system": false,
    "confirmed_at": "2020-06-05T10:39:52.30272Z",
    "created_at": "2020-06-04T21:08:35.432107Z",
    "updated_at": "2020-08-27T12:36:36.580037Z",
    "deleted_at": null
  }
}

{  "error": {    "code": 402402,    "message": "your request parameters didn't validate",    "invalid_params": [      {        "name": "language",        "reason": "oneof",        "message": "EN RU"      }    ]  }}

{
  "error": {
    "code": 402402,
    "message": "your request parameters didn't validate",
    "invalid_params": [
      {
        "name": "language",
        "reason": "oneof",
        "message": "EN RU"
      }
    ]
  }
}

Excluir avatar

DELETE {{baseHost}}/v1/avatar

Remove a imagem do avatar. Depois disso, é usado o avatar padrão.

Responses

{  "data": {    "id": "uFVdjPmQr9nPBhVodLVyEF",    "email": "user@example.com",    "full_name": "User updated1",    "auto": false,    "password_digest": "",    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",    "reset_password_token": "0000001111111111111111",    "language": "EN",    "system": false,    "confirmed_at": "2020-06-05T10:39:52.30272Z",    "created_at": "2020-06-04T21:08:35.432107Z",    "updated_at": "2020-08-27T12:36:36.580037Z",    "deleted_at": null  }}

{
  "data": {
    "id": "uFVdjPmQr9nPBhVodLVyEF",
    "email": "user@example.com",
    "full_name": "User updated1",
    "auto": false,
    "password_digest": "",
    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",
    "reset_password_token": "0000001111111111111111",
    "language": "EN",
    "system": false,
    "confirmed_at": "2020-06-05T10:39:52.30272Z",
    "created_at": "2020-06-04T21:08:35.432107Z",
    "updated_at": "2020-08-27T12:36:36.580037Z",
    "deleted_at": null
  }
}

{  "error": {    "code": 402402,    "message": "your request parameters didn't validate",    "invalid_params": [      {        "name": "language",        "reason": "oneof",        "message": "EN RU"      }    ]  }}

{
  "error": {
    "code": 402402,
    "message": "your request parameters didn't validate",
    "invalid_params": [
      {
        "name": "language",
        "reason": "oneof",
        "message": "EN RU"
      }
    ]
  }
}

Exibir avatar

GET {{baseHost}}/v1/workspace/avatar/:avatar_id

Retorna os bytes da imagem do avatar.

curl -X GET \  '{{baseHost}}/v1/workspace/avatar/:avatar_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/workspace/avatar/:avatar_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Moderators

Obter moderadores

GET {{baseHost}}/v1/moderators

Retorna a lista de moderadores. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses

{  "meta": {    "pagination": {      "page": 1,      "per_page": 10,      "total": 1    },    "order": {      "created_at": "asc"    }  },  "data": [    {      "user_id": "<UUID>",      "workspace_id": "<UUID>",      "username": "doc_test_mod_1776899949",      "email": "user@example.com",      "scope": {}    }  ]}

{
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 10,
      "total": 1
    },
    "order": {
      "created_at": "asc"
    }
  },
  "data": [
    {
      "user_id": "<UUID>",
      "workspace_id": "<UUID>",
      "username": "doc_test_mod_1776899949",
      "email": "user@example.com",
      "scope": {}
    }
  ]
}

Adicionar moderador

POST {{baseHost}}/v1/moderators

Cria um moderador. Em caso de sucesso, retorna o objeto criado.

Request body (json)

{  "username": "user_admin",  "email": "user@example.com",  "password": "password"}

{
  "username": "user_admin",
  "email": "user@example.com",
  "password": "password"
}

Responses

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin",    "email": "user@example.com"  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "user_admin",
    "email": "user@example.com"
  }
}

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949",    "email": "user@example.com",    "scope": {}  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "doc_test_mod_1776899949",
    "email": "user@example.com",
    "scope": {}
  }
}

curl -X POST \  '{{baseHost}}/v1/moderators' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "username": "user_admin",  "email": "user@example.com",  "password": "password"}'

curl -X POST \
  '{{baseHost}}/v1/moderators' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "user_admin",
  "email": "user@example.com",
  "password": "password"
}'

Obter moderador

GET {{baseHost}}/v1/moderators/:moderator_id

Retorna os dados de um moderador pelo seu identificador único.

Responses

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin",    "email": "user@example.com"  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "user_admin",
    "email": "user@example.com"
  }
}

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949",    "email": "user@example.com",    "scope": {}  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "doc_test_mod_1776899949",
    "email": "user@example.com",
    "scope": {}
  }
}

curl -X GET \  '{{baseHost}}/v1/moderators/:moderator_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/moderators/:moderator_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Atualizar moderador

PUT {{baseHost}}/v1/moderators/:moderator_id

Atualiza o moderador indicado. Só os campos enviados no corpo da requisição são alterados; os demais ficam como estão.

Request body (json)

{  "username": "user_admin_2",  "email": "user@example.com",  "password": "password"}

{
  "username": "user_admin_2",
  "email": "user@example.com",
  "password": "password"
}

Responses

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin_2",    "email": "user@example.com"  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "user_admin_2",
    "email": "user@example.com"
  }
}

{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949_upd",    "email": "user@example.com",    "scope": {}  }}

{
  "data": {
    "user_id": "<UUID>",
    "workspace_id": "<UUID>",
    "username": "doc_test_mod_1776899949_upd",
    "email": "user@example.com",
    "scope": {}
  }
}

curl -X PUT \  '{{baseHost}}/v1/moderators/:moderator_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "username": "user_admin_2",  "email": "user@example.com",  "password": "password"}'

curl -X PUT \
  '{{baseHost}}/v1/moderators/:moderator_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "user_admin_2",
  "email": "user@example.com",
  "password": "password"
}'

Excluir moderador

DELETE {{baseHost}}/v1/moderators/:moderator_id

Exclui o moderador permanentemente. A ação não pode ser desfeita.

Responses

{  "data": {    "success": true  }}

{
  "data": {
    "success": true
  }
}

{  "data": {    "success": true  }}

{
  "data": {
    "success": true
  }
}

curl -X DELETE \  '{{baseHost}}/v1/moderators/:moderator_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X DELETE \
  '{{baseHost}}/v1/moderators/:moderator_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'