Developer Center
Pesquisar K

Appearance

Requisitando Informações do Usuário ​

Após o login, provavelmente sua aplicação precisará de informações básicas do usuário logado. Dada essa necessidade, a Layers disponibiliza rotas para que as aplicações consigam facilmente os dados do usuário logado.

Requisições ​

Todos os endpoints abaixo devem ser autenticados da seguinte forma:

Informações da Conta ​

bash
curl -X GET https://api.layers.digital/v1/oauth/account/info \
  -H "Authorization: Bearer {{access token}}"

Retorna os detalhes de uma conta e suas comunidades Caso utilize mais de um item na chave includes, é necessário separar por vírgulas

Exemplo de chamada com includes:

bash
curl -X GET "https://api.layers.digital/v1/oauth/account/info?includes=communities" \
  -H "Authorization: Bearer {{access token}}"

A API retornará um JSON com o seguinte formato:

Resposta: ​

js
{
    "createdAt": Date,
    "email": String,
    "firstName": String,
    "id": String,
    "language": String,
    "lastName": String,
    "name": String,
    "timezone": String,
    "updatedAt": String,
    "communities": [
        {
            "color": String,
            "community": String,
            "icon": String,
            "name": String
        }
    ]
}

Informações do Usuário ​

bash
curl -X GET "https://api.layers.digital/v1/oauth/user/info" \
  -H "Authorization: Bearer {{access token}}" \
  -H "Community-Id: {{communityId}}"

Retorna os detalhes de um usuário, turmas e alunos Caso utilize mais de um item na chave includes, é necessário separar por vírgulas

Exemplo de chamada com includes:

bash
curl -X GET "https://api.layers.digital/v1/oauth/user/info?includes=communities,groups" \
  -H "Authorization: Bearer {{access token}}" \
  -H "Community-Id: {{communityId}}"

A API retornará um JSON com o seguinte formato:

Resposta: ​

js
{
    "user": {
        "lastSeenAt": Date,
        "id": String,
        "createdAt": Date,
        "updatedAt": Date,
        "alias": String,
        "roles": String,
        "permissions": String
    },
    "community": {
        "color": String,
        "community": String,
        "icon": String,
        "name": String,
    }
    "groups": [
        {
            "id": String,
            "name": String,
            "alias": String,
            "createdAt": Date,
            "updatedAt": Date,
            "season": String,
            "enrollment": {
                "id": String,
                "kind": String,
                "entity": String,
                "group": String,
                "createdAt": Date,
                "updatedAt": Date
            }
        }
    ],
    "members": [
        {
            "name": String,
            "createdAt": String,
            "updatedAt": String,
            "alias": String,
            "id": String
            "groups": [
                {
                    "id": String,
                    "name": String,
                    "alias": String,
                    "createdAt": Date,
                    "updatedAt": Date,
                    "season": String,
                    "enrollment": {
                        "id": String,
                        "kind": String,
                        "entity": String,
                        "group": String,
                        "createdAt": Date,
                        "updatedAt": Date
                    }
                }
            ]
        }
    ]
}

ATENÇÃO: Os comentários foram adicionados apenas para explicar as estruturas de dados, nem a requisição e nem a resposta devem ter comentários, ambos devem ser JSONs válidos.