Campos de usuário
Todos os campos de um objeto de usuário, com descrição, valor padrão e valores aceitos.
Um usuário tem várias propriedades, cada uma representada por um campo. Esta página lista todos os campos aceitos, com descrição, valor padrão e valores aceitos. O * marca um campo obrigatório.
Campos do usuário
| Campo | Descrição | Valor padrão | Valores aceitos |
|---|---|---|---|
email* | O e-mail do usuário. | nenhum | Um endereço de e-mail válido |
user_type* | Tipo de usuário: A para administrador, C para cliente. | nenhum | A, C |
company_id* | ID da loja ou do vendedor a que o usuário pertence. | ID da empresa padrão | integer |
status* | Status do usuário: A para ativo, D para desativado, H para oculto. | A | A, D, H |
firstname | O primeiro nome do usuário. | nenhum | string |
lastname | O sobrenome do usuário. | nenhum | string |
company | A empresa do usuário. | Your company | string |
company_name | O mesmo que company. | nenhum | string |
is_root | Se Y, o usuário é administrador raiz. Se N, não é. | Y para administrador, N para cliente | Y, N |
user_id | ID do usuário. Usado só se a configuração "Usar e-mail como login" estiver desativada. | Definido automaticamente | integer |
user_login | O login do usuário. | nenhum | string |
timestamp | Carimbo de data e hora da criação. | Definido automaticamente | Timestamp válido, em segundos |
password | O hash MD5 da senha do usuário. Usado só ao criar e ao atualizar um usuário. | nenhum | string |
Exemplo de requisição de usuário
bash
curl -X POST "$BASE_URL/api/users" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "john.doe@example.com",
"user_type": "C",
"company_id": 1,
"status": "A",
"firstname": "John",
"lastname": "Doe",
"company": "Acme Corporation",
"password": "5f4dcc3b5aa765d61d8327deb882cf99"
}'Onde os campos são usados
Os campos acima valem para as cinco chamadas sobre usuários: GET /api/users (listar), GET /api/users/{id} (consultar), POST /api/users (criar), PUT /api/users/{id} (atualizar) e DELETE /api/users/{id} (excluir). As requisições e respostas estão na página Endpoints de usuários.