api person Page History

People - API

Lista Pessoas

Pega uma lista de pessoas

Está requisição utiliza os parâmetros de paginação page e per_page para restringir a lista de usuários.

GET /people

{
  "people": [
    {
      "identifier": "guest",
      "name": "guest",
      "id": 55,
      "created_at": "2016/01/27 17:12:16",
      "updated_at": "2016/01/27 17:12:19",
      "additional_data": {},
      "image": null,
      "region": null,
      "user": {
        "id": 52,
        "login": "guest"
      }
    }
  ]
}

Mostra a pessoa associada a você

Retorna a pessoa associada ao usuário do private_token utilizado

GET /people/me

Mostra uma única pessoa

Retorna uma única pessoa

GET /people/:id

Parâmetros:

  • id (obrigatório) - o ID da pessoa

Note que este id é diferente do id de user

{
  "person": {
    "identifier": "guest",
    "name": "guest",
    "id": 55,
    "created_at": "2016/01/27 17:12:16",
    "updated_at": "2016/01/27 17:12:19",
    "additional_data": {},
    "image": null,
    "region": null,
    "user": {
      "id": 52,
      "login": "guest"
    }
  }
}

Mostra permissões da pessoa

Mostra as permissões da pessoa para cada comunidade.

GET /people/:id/permissions

Parâmetros:

  • id (obrigatório) - o ID do usuário
{
  "save-free-software": [
    "invite_members"
  ]
}

Mostra as amizades da pessoa

Retorna as amizades da pessoa

GET /people/:id/friends

Parâmetros:

  • id (obrigatório) - o ID do usuário
{
  "people": [
    {
      "identifier": "paula-oliveira",
      "name": "Paula Oliveira",
      "id": 44,
      "created_at": "2016/01/27 17:12:11",
      "updated_at": "2016/01/27 17:12:18",
      "additional_data": {},
      "image": null,
      "region": null,
      "user": {
        "id": 41,
        "login": "paula-oliveira"
      }
    },
    {
      "identifier": "paula-abreu",
      "name": "Paula Abreu",
      "id": 43,
      "created_at": "2016/01/27 17:12:11",
      "updated_at": "2016/01/27 17:12:18",
      "additional_data": {},
      "image": null,
      "region": null,
      "user": {
        "id": 40,
        "login": "paula-abreu"
      }
    }
  ]
}

Criar uma pessoa(usuário)

Cria uma pessoa(usuário) e a retorna.

O usuário ainda precisará ser ativado

POST /people

Parâmetros:

  • person[login] (obrigatório) - O login do usuário.
  • person[password] (obrigatório) - A senha do usuário.
  • person[password_confirmation] (obrigatório) - A senha do usuário.
  • person[email] (obrigatório) - O email da pessoa.

  • person[name] - Nome da pessoa.

  • Outros campos adicionais também podem ser inseridos seguindo o mesmo formato. Campos customizados criados dinamicamente pelo administrador também são inseridos da mesma forma. Entretanto eles são apresentados nas respostas dentro da estrutura additional_data.

  • person[custom_field] - qualquer campo custom_field criado dinamicamente pelo administrador

{
  "person": {
    "identifier": "test4",
    "name": "test4",
    "id": 70,
    "created_at": "2016/02/04 17:42:34",
    "updated_at": "2016/02/04 17:42:34",
    "additional_data": {},
    "image": null,
    "region": null,
    "user": {
      "id": 66,
      "login": "test4"
    }
  }
}

Atualiza uma pessoa(usuário)

Atualiza compos de uma pessoa e a retorna. O private_token passado precisa ser o da pessoa que está sendo alterada

POST /people/:id

Parâmetros:

  • person[email] - O email da pessoa.
  • person[name] - Nome da pessoa.
  • Outros campos adicionais também podem ser inseridos seguindo o mesmo formato.
{
  "person": {
    "identifier": "test7",
    "name": "Test7",
    "id": 73,
    "created_at": "2016/02/04 17:53:17",
    "updated_at": "2016/02/04 18:01:05",
    "additional_data": {},
    "image": null,
    "region": null,
    "user": {
      "id": 69,
      "login": "test7"
    }
  }
}

Registra um usuário

Similar ao acima, mas com menos parâmetros.

POST /register

Parâmetros:

  • login (obrigatório) - O login do usuário.
  • password (obrigatório) - A senha do usuário.
  • password_confirmation (obrigatório) - A senha do usuário.
  • email (obrigatório) - O email do usuário.
{
  "user": {
    "id": 69,
    "login": "test7",
    "email": "test7@mail.com",
    "activated": false,
    "person": {
      "identifier": "test7",
      "name": "test7@mail.com",
      "id": 73,
      "created_at": "2016/02/04 17:53:17",
      "updated_at": "2016/02/04 17:53:17",
      "additional_data": {},
      "image": null,
      "region": null,
      "user": {
        "id": 69,
        "login": "test7"
      }
    },
    "permissions": {
      "i-like-the-environment": [
        "invite_members"
      ]
    },
    "private_token": "0472f2fb175ecd6c3f415854dfda38c9"
  }
}
Last edited by Marcos Pereira