Leitores

Um leitor é um usuário que acessará e utilizará os conteúdos e funcionalidades da plataforma, tais como a leitura de livros e artigos, o recebimento de conteúdos recomendados através de prateleiras e coleções, bem como a realização de atividades propostas por um professor, por exemplo.

Esse leitor está obrigatoriamente alocado em uma turma e não possui acesso a nenhum recurso administrativo. Como já mencionado na seção “Estruturas Organizacionais”, o acervo visualizado pelo leitor, bem como as recomendações recebidas na página inicial após o login, são limitadas de acordo com a configuração da conta à qual o leitor está associado.

Atualmente, um leitor não pode estar em mais de uma turma.

Criação de um leitor

POST /api/v2/partners/readers

Atributos

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome do leitor. Ex: `John Doe`
`email`	string	não	E-mail do leitor. Ex: `john.doe@reader.com`
`phone`	string	não	Telefone do leitor. Ex: `(00) 00000-0000`
`reference_id`	string	sim	ID de referência do parceiro
`entity_reference_id`	string	sim	ID de referência da entidade associada ao leitor

Request

POST /api/v2/partners/readers
Authorization: APIAuth access_key_id:signature
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john.doe@reader.com",
    "phone": "(00) 00000-0000",
    "reference_id": "7hx8dapxiwtve0z1i3wfdbp9-5r3-c8njb45",
    "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6"
}

Response

201 Created

{
    "data": {
        "access_token": "ABC1234",
        "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
        "name": "John Doe",
        "email": "john.doe@reader.com",
        "phone": "(00) 00000-0000",
        "reference_id": "7hx8dapxiwtve0z1i3wfdbp9-5r3-c8njb45"
    },
    "errors": null,
    "pagination": null
}

Exibição de um leitor

GET /api/v2/partners/readers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do leitor. Ex: `ejhb-uty94l129tbhc-r8kwt-u-xf7nw776t`

Request

GET /api/v2/partners/readers/{reference_id}
Authorization: APIAuth access_key_id:signature

Response

200 OK

{
    "data": {
      "access_token": "EDF4567",
      "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
      "name": "Richard Smith",
      "email": "richard.smith@reader.com",
      "phone": "(00) 00000-0000",
      "reference_id": "ejhb-uty94l129tbhc-r8kwt-u-xf7nw776t",
      "active": true
    },
    "errors": null,
    "pagination": null
}

Edição de um leitor

PUT /api/v2/partners/readers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do leitor. Ex: `ejhb-uty94l129tbhc-r8kwt-u-xf7nw776t`

Atributos

Campo	Tipo	Obrigatório	Descrição
`name`	string	não	Nome do leitor. Ex: `John Doe`
`email`	string	não	E-mail do leitor. Ex: `john.doe@reader.com`
`phone`	string	não	Telefone do leitor. Ex: `(00) 00000-0000`
`entity_reference_id`	string	não	ID de referência da entidade associada ao leitor
`active`	boolean	não	Indica se o leitor está ativo

Request

PUT /api/v2/partners/readers/{reference_id}
Authorization: APIAuth access_key_id:signature
Content-Type: application/json

{
    "name": "Richard Miles",
    "email": "richard.miles@reader.com",
    "phone": "(00) 12345-6789",
    "active": true,
    "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6"
}

Response

200 OK

{
    "data": {
      "access_token": "EDF4567",
      "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
      "name": "Richard Miles",
      "email": "richard.miles@reader.com",
      "phone": "(00) 12345-6789",
      "reference_id": "ejhb-uty94l129tbhc-r8kwt-u-xf7nw776t",
      "active": true
    },
    "errors": null,
    "pagination": null
}

Exclusão de um leitor

DELETE /api/v2/partners/readers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do leitor. Ex: `ejhb-uty94l129tbhc-r8kwt-u-xf7nw776t`

Request

DELETE /api/v2/partners/readers/{reference_id}
Authorization: APIAuth access_key_id:signature

Response

204 No Content — leitor removido com sucesso.