Usuários

Nesta seção estão disponibilizados todos os métodos referentes á usuários desde á importação em massa até uma simples atualização de estado.

Atenção: O {token_da_plataforma} é disponibilizado pelo administrador da plataforma. Ele pode encontrar seu token acessando a dashboard, na página de: Plataforma > Configurações > Token.

Importante: Sempre altere os dados entre chaves com o parâmetro respectivo.

Exemplo prático:

No metodo estará descrevendo a rota como:

URL_BASE/users/show-id/{id}/{token_do_desenvolvedor}/{token_da_plataforma}

Como ficará na prática:

URL_BASE/users/show-id/66caec96-...432/66caec96-4749-...e07ed7/66caec96-...4324

Buscando usuário

Busca de usuário por id, e-mail, documento e id de referência.

Busca por ID.

GET URL_BASE/users/show-id/{id}/{token_do_desenvolvedor}/{token_da_plataforma}

Nesta rota troque o termo {id} pelo id do usuário que deseja buscar.

200: OK Usuário encontrado com sucesso

        {
            "id": "UUID",
            "name": "Novo",
            "last_name": "Aluno(a)",
            "email": "[email protected]",
            "photo_url": null,
            "document": "000.000.000-00",
            "genre": null,
            "birth": null,
            "phone": null,
            "status": 1,
            "created_at": "YYYY-MM-DD H:i:s",
            "updated_at": "YYYY-MM-DD H:i:s",
            "subscription": {
                "id": "0",
                "tenant_id": 0,
                "active": 1,
                "user_id": "UUID",
                "package_id": "UUID",
                "expiration_date": "YYYY-MM-DD H:i:s",
                "created_at": "YYYY-MM-DD H:i:s",
                "updated_at": "YYYY-MM-DD H:i:s",
            }
        }

400: Bad Request Usuário não encontrado (Verifique o ID)

Busca por documento.

GET URL_BASE/users/show-document/{document}/{token_do_desenvolvedor}/{token_da_plataforma}

Nesta rota troque o termo {document} pelo documento do usuário que deseja buscar.

200: OK Usuário encontrado com sucesso

 {
            "id": "UUID",
            "name": "Novo",
            "last_name": "Aluno(a)",
            "email": "[email protected]",
            "photo_url": null,
            "document": "000.000.000-00",
            "genre": null,
            "birth": null,
            "phone": null,
            "status": 1,
            "created_at": "YYYY-MM-DD H:i:s",
            "updated_at": "YYYY-MM-DD H:i:s",
            "subscription": {
                "id": "0",
                "tenant_id": 0,
                "active": 1,
                "user_id": "UUID",
                "package_id": "UUID",
                "expiration_date": "YYYY-MM-DD H:i:s",
                "created_at": "YYYY-MM-DD H:i:s",
                "updated_at": "YYYY-MM-DD H:i:s",
            }
        }

400: Bad Request Usuário não encontrado (Verifique o documento)

Busca por e-mail.

GET URL_BASE/users/show-email/{email}/{token_do_desenvolvedor}/{token_da_plataforma}

Nesta rota troque o termo {email} pelo email do usuário que deseja buscar.

200: OK Usuário encontrado com sucesso

 {
            "id": "UUID",
            "name": "Novo",
            "last_name": "Aluno(a)",
            "email": "[email protected]",
            "photo_url": null,
            "document": "000.000.000-00",
            "genre": null,
            "birth": null,
            "phone": null,
            "status": 1,
            "created_at": "YYYY-MM-DD H:i:s",
            "updated_at": "YYYY-MM-DD H:i:s",
            "subscription": {
                "id": "0",
                "tenant_id": 0,
                "active": 1,
                "user_id": "UUID",
                "package_id": "UUID",
                "expiration_date": "YYYY-MM-DD H:i:s",
                "created_at": "YYYY-MM-DD H:i:s",
                "updated_at": "YYYY-MM-DD H:i:s",
            }
        }

400: Bad Request Usuário não encontrado (Verifique o documento)

Busca por id de referência .

GET URL_BASE/users/show-reference/{reference_id}/{token_do_desenvolvedor}/{token_da_plataforma}

Nesta rota troque o termo {reference_id} pelo id de referência do usuário que deseja buscar.

200: OK Usuário encontrado com sucesso

 {
            "id": "UUID",
            "name": "Novo",
            "last_name": "Aluno(a)",
            "email": "[email protected]",
            "photo_url": null,
            "document": "000.000.000-00",
            "genre": null,
            "birth": null,
            "phone": null,
            "status": 1,
            "created_at": "YYYY-MM-DD H:i:s",
            "updated_at": "YYYY-MM-DD H:i:s",
            "subscription": {
                "id": "0",
                "tenant_id": 0,
                "active": 1,
                "user_id": "UUID",
                "package_id": "UUID",
                "expiration_date": "YYYY-MM-DD H:i:s",
                "created_at": "YYYY-MM-DD H:i:s",
                "updated_at": "YYYY-MM-DD H:i:s",
            }
        }

400: Bad Request Usuário não encontrado (Verifique o documento)

Criando usuário(s)

Então vamos ao método de criação de usuário(s):

Exemplo de JSON para criação de um ou mais usuários:

Criar um ou mais usuários.

POST URL_BASE/users/create/{token_do_desenvolvedor}/{token_da_plataforma}

Usar JSON de exemplo que esta logo abaixo.

200: OK Dados enviados para a fila.

{
	"product_id" : ["123456789"],
	"users": [
		{
		 "name": "Aluno",
		 "last_name":"teste",
		 "email":"[email protected]", // dado obrigatório
		 "password": "senhadoalunoopcional", // dado opcional
		 "document":"123.456.789-10",
		 "phone":"(11)99999-9999",
		 "reference_id": "789456123546",
		 "accession_date" : "YYYY-MM-DD",
		},{
		 "name": "Aluno",
		 "last_name":"teste",
		 "email":"[email protected]", // dado obrigatório
		 "password": "senhadoalunoopcional", // dado opcional		 
		 "document":"123.456.789-10",
		 "phone":"(11)99999-9999",
		 "reference_id": "789456123546",
		  "accession_date" : "YYYY-MM-DD",
		}
	]
}

A propriedade product_id refere-se ao product_id registrado no plano criado no painel administrador da The Members. Essa propriedade é de extrema importancia. Com esse valor criamos a inscrição do aluno á plataforma do infoprodutor.

Exclusão de usuário

Excluir por id.

DELETE URL_BASE/users/destroy-user-id/{user_id}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

200: OK Usuário excluído com sucesso.

{
    // Response
}

400: Bad Request Usuário não encontrado.

Excluir por documento.

DELETE URL_BASE/users/destroy-document/{document}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

200: OK Usuário excluído com sucesso.

{
    // Response
}

400: Bad Request Usuário não encontrado.

Excluir por email.

DELETE URL_BASE/users/destroy-email/{email}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

200: OK Usuário excluído com sucesso.

{
    // Response
}

400: Bad Request Usuário não encontrado.

Excluir por id de referência.

DELETE URL_BASE/users/destroy-reference-id/{reference_id}/{token_do_desenvolvedor}/{token_da_plataforma}

Após a exclusão do usuário a operação não poderá ser revertida.

200: OK Usuário excluído com sucesso.

{
    // Response
}

400: Bad Request Usuário não encontrado.