{"info":{"_postman_id":"6ff53123-0bb3-43f4-b69d-4d9d1835b25b","name":"API de Integração - Niduu","description":"

Descrição

Esse documento apresenta a interface de programação de aplicativos (API) da Niduu. Ele descreve várias operações da API, estruturas de requisições e resposta relacionadas.

Autorização

A autorização na API é feita através do parâmetro de requisição secret em cada requisição, que consiste em uma chave de API UUID no formato RFC 4122.

Ex.:

https://module.api.niduu.com/integrate/?secret=ea0d435e-8111-11eb-a32a-7c8ae1e10db1\n\n

Enviar um valor para secret inválido ou deixar de enviar esse parâmetro acarretará na falha na requisição gerando uma resposta do tipo HTTP 403 PERMISSION DENIED.

IMPORTANTE: Não realize requisições para essa API em aplicações do lado cliente (ex.: javascript no navegador de internet), a chave de API secret deve ser armazenada e utilizada de forma segura na aplicação do lado servidor. Por esse motivo, visando ressaltar o uso seguro desta API, o CORS não é habilitado.

Para solicitar acesso à API de integração e obter uma chave de API, contacte-nos através do e-mail suporte-empresa@gupy.com.br.

Formato

A API de Integração recebe e envia dados no formato JSON, portanto convém enviar o cabeçalho HTTP Content-Type: application/json.

Fuso Horário

Por padrão, todos os valores que representam data e hora retornados nas requisições dessa API estão no fuso horário GMT (UTC+0).

Internacionalização

A API retorna alguns atributos formatados de acordo com a localização e preferências de idioma do cliente, como por exemplo mensagens de erro e datas. Para a correta exibição desses atributos envie o cabeçalho HTTP Accept-Language.

Ex.: Accept-Language: pt-BR

Supressão de Requisições

O limite de uso dessa API é 1 requisição por segundo por chave de API. Usando acima desse limite a requisição falhará gerando uma resposta do tipo HTTP 429 TOO MANY REQUESTS.

Paginação

As requisições de listagem retornam em páginas de até 100 registros. Nessa API a estratégia de paginação utilizada é baseada em cursor e consiste no seguinte:

Cada página é identificada por um parâmetro chamado cursor
Cada página contém o cursor para próxima e para a anterior através dos atributos next_cursor e prev_cursor, respectivamente.
Dessa forma não é possível que a aplicação cliente acesse uma página específica (por exemplo page=7), necessitando percorrer as páginas sequencialmente; entretanto esse tipo de paginação oferece vantagens de desempenho em grandes conjuntos de dados e possui tempo de resposta semelhante independente da página solicitada.
Originalmente, na paginação baseada em cursor, não há o conceito do número total de páginas ou de total de registros na listagem, entretanto, para facilidade de uso, foi adicionado a essa API uma rota para consulta do número total de registros, bastando requisitar a rota de listagem adicionando o sufixo /count na URL.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Descrição","slug":"descricao"},{"content":"Autorização","slug":"autorizacao"},{"content":"Formato","slug":"formato"},{"content":"Fuso Horário","slug":"fuso-horario"},{"content":"Internacionalização","slug":"internacionalizacao"},{"content":"Supressão de Requisições","slug":"supressao-de-requisicoes"},{"content":"Paginação","slug":"paginacao"}],"owner":"10862356","collectionId":"6ff53123-0bb3-43f4-b69d-4d9d1835b25b","publishedId":"Tz5nbyGC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-30T19:41:24.000Z"},"item":[{"name":"Usuários","item":[{"name":"Listar Usuários","id":"a6552e14-8ac8-428d-93f4-879002df9857","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://auth.api.niduu.com/integrate/users/?secret=471ae9a7-a90a-43bc-9fd4-082ada984bdb&q=maria&cursor=cD0yMDcy","description":"

Obtém a lista de usuários registrados na Niduu.

Os registros são retornados de forma paginada conforme especificado no tópico paginação. Utilize o parâmetro cursor para avançar para as próximas páginas. Requisite .../users/count/?secret=... para obter o total de registros.

Opcionalmente aceita um parâmetro de consulta q que filtra os resultados por nome, cpf ou e-mail.

DESCRIÇÃO DOS ATRIBUTOS

id: [integer] - identificador do usuário
name: [string] - nome do usuário (usa preferencialmente o nome de registro cadastrado pelo Admin ou por essa API)
short_name: [string] - nome abreviado do usuário (usa preferencialmente o nome de perfil, cadastrado pelo próprio usuário np aplicativo)
nin: [numeric string] - National Identification Number (CPF para usuários brasileiros), para método de login baseado em CPF
id_number: [numeric string] - Identity Number (RG para usuários brasileiros), para recuperação de senha em login baseado em CPF - após definido para um usuário ativo não pode ser redefinido
email: [email string] - e-mail do usuário, para método de login baseado em e-mail - após cadastrado não pode ser alterado
birth_date: [formatted date string] - data de nascimento do usuário no formato YYYY-MM-DD
birth_date_i18n: [formatted date string] - data de nascimento do usuário em formato local
blocked: [boolean] - quando true esse usuário não pode acessar o conteúdo da Niduu
is_pre_registration: [boolean] - quando true indica que esse usuário é um pré-registro, quando false o usuário realizou seu primeiro login e definiu sua senha
mobile_internet_allowed: [boolean] - quando false o aplicativo não utilizará internet móvel do dispositivo
times_allowed: [object] - grade de horários permitidos para o uso no aplicativo - quando null não há restrições
metadata: [object] - dados extras no formato chave-valor para esse usuário - as chaves habilitadas para cadastro nesse campo precisam ser previamente registradas pelo Admin
created_at: [formatted datetime string] data/hora de criação desse usuário
created_at_i18n: [formatted datetime string] data/hora de criação desse usuário em formato local

\n","urlObject":{"protocol":"https","path":["integrate","users",""],"host":["auth","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"471ae9a7-a90a-43bc-9fd4-082ada984bdb"},{"description":{"content":"

exemplo de texto de busca (opcional)

\n","type":"text/plain"},"key":"q","value":"maria"},{"description":{"content":"

exemplo de cursor de paginação

\n","type":"text/plain"},"key":"cursor","value":"cD0yMDcy"}],"variable":[]}},"response":[{"id":"b323b523-5779-4058-8696-177af4fe6a63","name":"Exemplo 1","originalRequest":{"method":"GET","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://auth.api.niduu.com/integrate/users/?secret=ef59d8e2-8a47-462d-9f84-0aadde686b58","protocol":"https","host":["auth","api","niduu","com"],"path":["integrate","users",""],"query":[{"key":"secret","value":"ef59d8e2-8a47-462d-9f84-0aadde686b58"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Language","value":"pt-br","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"next_cursor\": \"cD0yMTYwMTk=\",\r\n \"prev_cursor\": null,\r\n \"results\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Edson Arantes do Nascimento\",\r\n \"short_name\": \"Pelé\",\r\n \"nin\": \"12345678900\",\r\n \"id_number\": \"9876543210\",\r\n \"email\": null,\r\n \"birth_date\": \"1940-10-23\",\r\n \"birth_date_i18n\": \"23/10/1940\",\r\n \"blocked\": false,\r\n \"is_pre_registration\": false,\r\n \"mobile_internet_allowed\": true,\r\n \"times_allowed\": {\r\n \"sun\": [],\r\n \"mon\": [\"08:00\",\"12:00\",\"14:00\",\"18:00\"],\r\n \"tue\": [\"08:00\",\"12:00\",\"14:00\",\"18:00\"],\r\n \"wed\": [\"08:00\",\"12:00\",\"14:00\",\"18:00\"],\r\n \"thu\": [\"08:00\",\"12:00\",\"14:00\",\"18:00\"],\r\n \"fri\": [\"08:00\",\"12:00\",\"14:00\",\"18:00\"],\r\n \"sat\": [\"08:00\",\"12:00\"]\r\n },\r\n \"metadata\": {\r\n \"Profissão\": \"Jogador de Futebol\",\r\n \"País\": \"Brasil\"\r\n },\r\n \"created_at\": \"2020-12-23T18:34:11.442838Z\",\r\n \"created_at_i18n\": \"23/12/2020 18:34\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"Diego Armando Maradona Franco\",\r\n \"short_name\": \"Diego Maradona\",\r\n \"nin\": null,\r\n \"id_number\": null,\r\n \"email\": \"contacto@diegomaradonagroup.com\",\r\n \"birth_date\": \"1960-10-30\",\r\n \"birth_date_i18n\": \"30/10/1960\",\r\n \"blocked\": true,\r\n \"is_pre_registration\": false,\r\n \"mobile_internet_allowed\": false,\r\n \"times_allowed\": null,\r\n \"metadata\": {\r\n \"Profissão\": \"Jogador de Futebol\",\r\n \"País\": \"Argentina\"\r\n },\r\n \"created_at\": \"2020-12-23T18:35:17.442838Z\",\r\n \"created_at_i18n\": \"23/12/2020 18:35\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"name\": \"José Silva Santos\",\r\n \"short_name\": \"José Santos\",\r\n \"nin\": \"11111111111\",\r\n \"id_number\": null,\r\n \"email\": null,\r\n \"birth_date\": null,\r\n \"birth_date_i18n\": null,\r\n \"blocked\": false,\r\n \"is_pre_registration\": true,\r\n \"mobile_internet_allowed\": true,\r\n \"times_allowed\": null,\r\n \"metadata\": null,\r\n \"created_at\": \"2020-12-23T18:34:11.442838Z\",\r\n \"created_at_i18n\": \"23/12/2020 18:34\"\r\n },\r\n { ... }\r\n ]\r\n}"}],"_postman_id":"a6552e14-8ac8-428d-93f4-879002df9857"},{"name":"Detalhar Usuário","id":"e47897b5-2baf-450f-96c8-61fa931f9c15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://auth.api.niduu.com/integrate/users/{id}/?secret=1a0e7c0b-fb3a-4261-92ee-89cf1e5387ca","description":"

Obtém um usuário específico registrado na Niduu.

Substitua {id} na URL por um id de usuário.

Veja Listar Usuários.

\n","urlObject":{"protocol":"https","path":["integrate","users","{id}",""],"host":["auth","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"1a0e7c0b-fb3a-4261-92ee-89cf1e5387ca"}],"variable":[]}},"response":[],"_postman_id":"e47897b5-2baf-450f-96c8-61fa931f9c15"},{"name":"Cadastrar/Atualizar Usuários","id":"11c262f8-6359-4a47-bb59-2799673aae0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n // {\n // \"name\": \"Diego Armando Maradona Franco\",\n // \"email\": \"contacto@diegomaradonagroup.com\",\n // \"lang\": \"es\",\n // \"birth_date\": \"1960-10-30\",\n // \"mobile_internet_allowed\": false,\n // \"metadata\": {\n // \"Profissão\": \"Jogador de Futebol\",\n // \"País\": \"Argentina\"\n // }\n // },\n {\n \"name\": \"Renata Teste SSO NIN\",\n \"nin\": \"07617266677\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{AUTH_API_URL}}/integrate/users/?secret=233150b1-1524-4029-82d6-833826fa495b","description":"

Cadastra ou atualiza os registros de usuários na Niduu

Essa rota realiza um upsert em lote de até 100 registros por requisição. O cadastro de um novo usuário ocorre quando o CPF ou e-mail enviado não está registrado, caso contrário o cadastro é atualizado com as informações enviadas.

DESCRIÇÃO DOS ATRIBUTOS

nin: [numeric string, required_unless:email] - National Identification Number (CPF para usuários brasileiros) - não pode ser enviado juntamente com email
email: [email string, max=100, required_unless:nin] - e-mail do usuário - não pode ser enviado juntamente com nin

nin e email são mutuamente exclusivos - é necessário enviar um desses atributos para cada registro do lote

name: [string, min=3, max=100, required] - nome completo do usuário - obrigatório
id_number: [numeric string, min=5, max=24, prohibited_unless:nin] - Identity Number (RG para usuários brasileiros), para recuperação de senha em login baseado em CPF, só pode ser enviado juntamente com nin - após ser definido para um usuário ativo não pode ser atualizado
lang: [string, required, in:pt,es,en] - língua do usuário - útil para o disparo do e-mail de cadastro - obrigatório
birth_date: [formatted date string, optional] - data de nascimento do usuário no formato YYYY-MM-DD - após ser definido para um usuário ativo não pode ser atualizado
times_allowed: [object, optional] - grade de horários permitidos para o uso no aplicativo (pares de horários representando o início e fim do intervalo) - quando null não há restrições
mobile_internet_allowed: [boolean, optional] - quando false o aplicativo não utilizará internet móvel do dispositivo
metadata: [object, optional] - dados extras no formato chave-valor para esse usuário - as chaves habilitadas para cadastro nesse campo precisam ser previamente registradas pelo Admin
group: [int, optional] - caso seja enviado adiciona o usuário ao grupo de ID especificado

Após recebido, o lote será processado em segundo plano e a estimativa do tempo de conclusão é retornada como resposta dessa requisição.

Obs.: Caso o registro de um usuário bloqueado seja enviado no lote, o mesmo será desbloqueado como parte da atualização.

\n","urlObject":{"path":["integrate","users",""],"host":["{{AUTH_API_URL}}"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"233150b1-1524-4029-82d6-833826fa495b"}],"variable":[]}},"response":[{"id":"10ef251c-b150-4ffe-a3b4-ea9351dc38f9","name":"Exemplo 1","originalRequest":{"method":"POST","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"Edson Arantes do Nascimento\",\r\n \"nin\": \"12345678900\",\r\n \"id_number\": \"9876543210\",\r\n \"birth_date\": \"1940-10-23\",\r\n \"times_allowed\": {\r\n \"sun\": [],\r\n \"mon\": [\"08:00\", \"12:00\", \"14:00\", \"18:00\"],\r\n \"tue\": [\"08:00\", \"12:00\", \"14:00\", \"18:00\"],\r\n \"wed\": [\"08:00\", \"12:00\", \"14:00\", \"18:00\"],\r\n \"thu\": [\"08:00\", \"12:00\", \"14:00\", \"18:00\"],\r\n \"fri\": [\"08:00\", \"12:00\", \"14:00\", \"18:00\"],\r\n \"sat\": [\"08:00\", \"12:00\"]\r\n },\r\n \"metadata\": {\r\n \"Profissão\": \"Jogador de Futebol\",\r\n \"País\": \"Brasil\"\r\n }\r\n },\r\n {\r\n \"name\": \"Diego Armando Maradona Franco\",\r\n \"email\": \"contacto@diegomaradonagroup.com\",\r\n \"lang\": \"es\",\r\n \"birth_date\": \"1960-10-30\",\r\n \"mobile_internet_allowed\": false,\r\n \"metadata\": {\r\n \"Profissão\": \"Jogador de Futebol\",\r\n \"País\": \"Argentina\"\r\n }\r\n },\r\n {\r\n \"name\": \"José Silva Santos\",\r\n \"nin\": \"11111111111\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://auth.api.niduu.com/integrate/users/?secret=64ed66a0-5199-411d-942a-b64df52cc22d","protocol":"https","host":["auth","api","niduu","com"],"path":["integrate","users",""],"query":[{"key":"secret","value":"64ed66a0-5199-411d-942a-b64df52cc22d","description":"exemplo de chave de API (obrigatório)"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Language","value":"pt-br","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ends_in\": \"2021-03-10 19:23:29\",\n \"ends_in_i18n\": \"10/03/2021 19:23\"\n}"}],"_postman_id":"11c262f8-6359-4a47-bb59-2799673aae0c"},{"name":"Desativar Usuário","id":"d7f1c11d-b9e0-409e-86f4-011905b2563a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept-Language","value":"pt-BR","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseURL}}/integrate/users/{id}/?secret=b5c2ab45-36f4-4680-94d8-9b99fd9b673e","description":"

Desativa um usuário específico registrado na Niduu.

Substitua {id} na URL por um id de usuário.

Caso o id seja de um pré-registro (usuário ainda não criou sua conta no aplicativo) essa rota exclui o usuário.

Caso o id seja de um registro efetivado (usuário já entrou no aplicativo) essa rota desativa o usuário.

\n","urlObject":{"path":["integrate","users","{id}",""],"host":["{{baseURL}}"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"b5c2ab45-36f4-4680-94d8-9b99fd9b673e"}],"variable":[]}},"response":[],"_postman_id":"d7f1c11d-b9e0-409e-86f4-011905b2563a"}],"id":"db2beb67-1f9d-4f64-9557-5565f6fcca80","description":"

Essa sessão descreve as requisições responsáveis pelo gerenciamento de usuários na Niduu.

Cada usuário é identificado pelo seu NIN (National identification Number - CPF para usuários brasileiros) ou e-mail, representando a forma de login do usuário no aplicativo.

Quando o usuário é cadastrado na Niduu é criado um \"pré-registro\", uma conta de marcação que só será ativada no momento do primeiro login no aplicativo, após a definição da senha.

\n","_postman_id":"db2beb67-1f9d-4f64-9557-5565f6fcca80"},{"name":"Grupos","item":[{"name":"Listar Grupos","id":"859b5dcd-4b98-460f-94b5-29e43b4ab268","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.niduu.com/integrate/groups/?secret=3b0ac92b-b4cf-4631-9f85-774c0b290808&q=vendas&cursor=xcTuGDtu","description":"

Obtém a lista de grupos registrados na Niduu.

Os registros são retornados de forma paginada conforme especificado no tópico paginação. Utilize o parâmetro cursor para avançar para as próximas páginas. Requisite .../groups/count/?secret=... para obter o total de registros.

Opcionalmente aceita um parâmetro de consulta q que filtra os resultados por nome.

DESCRIÇÃO DOS ATRIBUTOS

id: [integer] - identificador do grupo
name: [string] - nome do grupo
description: [string] - descrição do grupo
created_at: [formatted datetime string] data/hora de criação desse grupo
created_at_i18n: [formatted datetime string] data/hora de criação desse grupo em formato local

\n","urlObject":{"protocol":"https","path":["integrate","groups",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"3b0ac92b-b4cf-4631-9f85-774c0b290808"},{"description":{"content":"

exemplo de texto de busca (opcional)

\n","type":"text/plain"},"key":"q","value":"vendas"},{"description":{"content":"

exemplo de cursor de paginação

\n","type":"text/plain"},"key":"cursor","value":"xcTuGDtu"}],"variable":[]}},"response":[{"id":"245deb4d-6840-4f86-a267-c7899db5ef4f","name":"Exemplo 1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept-Language","value":"pt-BR","type":"text"}],"url":{"raw":"https://core.api.niduu.com/integrate/groups/?secret=d062b803-f781-4b63-83e3-d28c9611c2ae","protocol":"https","host":["core","api","niduu","com"],"path":["integrate","groups",""],"query":[{"key":"secret","value":"d062b803-f781-4b63-83e3-d28c9611c2ae"},{"key":"q","value":"vendas","disabled":true},{"key":"cursor","value":"xcTuGDtu","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Language:\n","value":" pt-br","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next_cursor\": null,\n \"prev_cursor\": null,\n \"results\": [\n {\n \"id\": 1,\n \"name\": \"Comercial\",\n \"description\": \"Equipe Comercial\",\n \"created_at\": \"2018-06-01T22:55:29.569242Z\",\n \"created_at_i18n\": \"01/06/2018\"\n },\n {\n \"id\": 2,\n \"name\": \"Marketing\",\n \"description\": \"Equipe de Marketing\",\n \"created_at\": \"2018-06-01T22:56:51.376992Z\",\n \"created_at_i18n\": \"01/06/2018\"\n },\n {\n \"id\": 3,\n \"name\": \"Devs\",\n \"description\": \"Equipe de Desenvolvimento\",\n \"created_at\": \"2018-06-01T22:58:32.697567Z\",\n \"created_at_i18n\": \"01/06/2018\"\n }\n ]\n}"}],"_postman_id":"859b5dcd-4b98-460f-94b5-29e43b4ab268"},{"name":"Detalhar Grupo","id":"f0bd3e22-5a6c-4c34-8351-fe96016f0ca8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.niduu.com/integrate/groups/{id}/?secret=577ad4e5-c299-4de3-9ff7-225920f0b22f","description":"

Obtém um grupo específico registrado na Niduu.

Substitua {id} na URL por um id de grupo.

Veja Listar Grupos.

\n","urlObject":{"protocol":"https","path":["integrate","groups","{id}",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"577ad4e5-c299-4de3-9ff7-225920f0b22f"}],"variable":[]}},"response":[],"_postman_id":"f0bd3e22-5a6c-4c34-8351-fe96016f0ca8"},{"name":"Listar Membros de um Grupo","id":"28667674-9a9f-4c13-aaf1-1c6b3aad9e76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.niduu.com/integrate/groups/{group_id}/members/?secret=842ea2d5-ea67-481a-93a1-fd2144296e15","description":"

Lista os usuários de um grupo existente na Niduu

Substitua {group_id} na URL por um id de grupo.

O funcionamento e parâmetros dessa rota segue como especificado em Listar Usuários.

DESCRIÇÃO DOS ATRIBUTOS

id: [integer] - identificador do usuário
name: [string] - nome do usuário (usa preferencialmente o nome de registro cadastrado pelo Admin ou por essa API)
nin: [numeric string] - National Identification Number (CPF para usuários brasileiros), para método de login baseado em CPF
email: [email string] - e-mail do usuário, para método de login baseado em e-mail

\n","urlObject":{"protocol":"https","path":["integrate","groups","{group_id}","members",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"842ea2d5-ea67-481a-93a1-fd2144296e15"}],"variable":[]}},"response":[],"_postman_id":"28667674-9a9f-4c13-aaf1-1c6b3aad9e76"},{"name":"Detalhar Membro de um Grupo","id":"a908c04d-2598-4693-bb32-8a6415a4f41a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.niduu.com/integrate/groups/{id}/members/{userId}?secret=c9e016e0-5bfc-4379-a346-f60c880630ed","description":"

Detalha um membro do grupo previamente cadastrado em Educorp

\n","urlObject":{"protocol":"https","path":["integrate","groups","{id}","members","{userId}"],"host":["core","api","niduu","com"],"query":[{"key":"secret","value":"c9e016e0-5bfc-4379-a346-f60c880630ed"}],"variable":[]}},"response":[],"_postman_id":"a908c04d-2598-4693-bb32-8a6415a4f41a"},{"name":"Listar Grupos de um Usuário","id":"869332eb-5e8c-49b0-8510-751f8af460cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://core.api.niduu.com/integrate/groups_of/{user_id}/?secret=a52d3398-ef71-4af6-a0ba-e78d159bb581&q=vendas&cursor=drYuGRgh","description":"

Obtém a lista de grupos de um usuário específico.

Substitua {user_id} na URL por um id de usuário.

O funcionamento, atributos e parâmetros dessa rota segue como especificado em Listar Grupos.

\n","urlObject":{"protocol":"https","path":["integrate","groups_of","{user_id}",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"a52d3398-ef71-4af6-a0ba-e78d159bb581"},{"description":{"content":"

exemplo de texto de busca (opcional)

\n","type":"text/plain"},"key":"q","value":"vendas"},{"description":{"content":"

exemplo de cursor de paginação

\n","type":"text/plain"},"key":"cursor","value":"drYuGRgh"}],"variable":[]}},"response":[],"_postman_id":"869332eb-5e8c-49b0-8510-751f8af460cd"},{"name":"Cadastrar Grupo","id":"53dadf72-c0f4-4ec9-840d-f1a4c62911dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.niduu.com/integrate/groups/?secret=36817d1f-aad1-46a5-a04f-940507cbdd84","description":"

Cadastra um novo grupo na Niduu

DESCRIÇÃO DOS ATRIBUTOS

name: [string, max=100, required] - nome completo do usuário - obrigatório
description: [string, max=200, optional] - descrição para esse grupo

\n","urlObject":{"protocol":"https","path":["integrate","groups",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"36817d1f-aad1-46a5-a04f-940507cbdd84"}],"variable":[]}},"response":[],"_postman_id":"53dadf72-c0f4-4ec9-840d-f1a4c62911dc"},{"name":"Adicionar Membro a um Grupo","id":"e2d83729-cb3a-41f7-ad8a-44ebbbc995f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://core.api.niduu.com/integrate/groups/{group_id}/members?secret=970b9871-b1b1-4796-8301-9efafd2472c3","description":"

Adiciona um usuário a um grupo existente na Niduu

Substitua {group_id} na URL por um id de grupo.

DESCRIÇÃO DOS ATRIBUTOS

id: [integer, required] - id do usuário que será adicionado ao grupo

\n","urlObject":{"protocol":"https","path":["integrate","groups","{group_id}","members"],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"970b9871-b1b1-4796-8301-9efafd2472c3"}],"variable":[]}},"response":[],"_postman_id":"e2d83729-cb3a-41f7-ad8a-44ebbbc995f2"},{"name":"Atualizar Grupo","id":"8f18b5e9-48bf-4bce-9ff0-79a20eab6d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://core.api.niduu.com/integrate/groups/{id}/?secret=f92b9c38-d53a-4c20-96c7-f5f20f3d92a0","description":"

Atualiza um grupo previamente cadastrado na Niduu

Substitua {id} na URL por um id de grupo.

DESCRIÇÃO DOS ATRIBUTOS

name: [string, max=100] - nome completo do usuário
description: [string, max=200] - descrição para esse grupo

Envie somente o(s) atributo(s) que necessitam de atualização.

\n","urlObject":{"protocol":"https","path":["integrate","groups","{id}",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"f92b9c38-d53a-4c20-96c7-f5f20f3d92a0"}],"variable":[]}},"response":[],"_postman_id":"8f18b5e9-48bf-4bce-9ff0-79a20eab6d64"},{"name":"Excluir Grupo","id":"c35170a5-9f28-457c-8450-020dc582db8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.niduu.com/integrate/groups/{id}/?secret=c9e016e0-5bfc-4379-a346-f60c880630ed","description":"

Exclui um grupo previamente cadastrado na Niduu

A exclusão é permanente e irreversível.

Atenção: se a deleção do grupo implicar na remoção de colaboradores, a request inicial falhará com o código 402 Not Acceptable. Para prosseguir reenvie a solicitação de exclusão com o cabeçalho (header) HTTP Confirmation-Code recebido. O frontend deve alertar o usuário com a pergunta recebida no detail dessa falha.

\n","urlObject":{"protocol":"https","path":["integrate","groups","{id}",""],"host":["core","api","niduu","com"],"query":[{"description":{"content":"

exemplo de chave de API (obrigatório)

\n","type":"text/plain"},"key":"secret","value":"c9e016e0-5bfc-4379-a346-f60c880630ed"}],"variable":[]}},"response":[],"_postman_id":"c35170a5-9f28-457c-8450-020dc582db8f"},{"name":"Excluir Membro do Grupo","id":"c01b100e-7d31-4010-86c4-d3aeb9750cf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://core.api.niduu.com/integrate/groups/{id}/members/{userId}?secret=c9e016e0-5bfc-4379-a346-f60c880630ed","description":"

Exclui um membro do grupo previamente cadastrado em Educorp

Essa sessão descreve as requisições responsáveis pelo gerenciamento de grupos na Niduu.

Grupos são coleções de usuários e tem por finalidade facilitar a separação de permissões de acesso ao conteúdo disponível dentro da Niduu.

O caso mais comum é a utilização de grupos para especificar quais usuários terão acesso a uma determinada campanha.

\n","_postman_id":"6abdf533-d05e-4bd7-9fe9-830701d7064e"}],"event":[{"listen":"prerequest","script":{"id":"bcf3a82f-cfad-4acc-bb9d-510d7cb9bc39","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"38fbaf3d-91db-4689-8685-cdfbe1df1ec0","type":"text/javascript","exec":[""]}}]}