Usuários

Adicionar Usuário

https://api.premepay.com/v1/users

Lista de Descrição dos Campos

Parâmetro
Tipo
Descrição
Obrigatório
name
string
nome
Sim
username
email
email
Sim
password
string
senha
Sim
permission
object
Permissão
Não
entityId
int
identificador
Sim
entityType
string
Store ou Business
Sim
role
int
Role
Sim

Exemplo de Requisição para Adicionar Usuário

Este é um exemplo de como a sua requisição para adicionar um consumidor deve parecer. É assim que você pode salvar os dados de um cliente no nosso banco de dados.
{
"name": "Felipe Gabriel",
"username": "[email protected]",
"password": "xx%$TFDSFASDFAV.ARReee",
"permission": {
"entityId": 5,
"entityType": "Store",
"role": 2,
}
}

Respostas

Caso a sua requisição seja bem sucedida, você irá receber o retorno do objeto do consumidor.
Caso sua requisição tenha os parâmetros de criação inválidos - por exemplo, especificando um cupom ou uma fonte inválida - você pode receber como resposta o retorno de um erro. Veja abaixo a lista completa de respostas possíveis.

200: OK

Esta é a resposta para os casos em que sua requisição seja bem sucedida.
{
"id":555,
"name": "Felipe Gabriel",
"username": "[email protected]",
"password": "xx%$TFDSFASDFAV.ARReee",
"permission": {
"entityId": 5,
"entityType": "Store",
"role": 2,
}
}

401: Unauthorized

Esta é a resposta para os casos em que a solicitação não foi bem sucedida porque não possui credenciais de autenticação válidas para o recurso de destino. Caso seja necessário, você pode rever o nosso processo de autenticação.
{
"type": "https://httpstatuses.com/401",
"title": "Unauthorized",
"status": 401,
"detail": null,
"instance": null,
"extensions": {}
}

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"status": 403,
"detail": null,
"instance": null,
"extensions": {}
}

Excluir Usuário do tipo Store

https://api.premepay.com/v1/store/{storeId:int}/users/{userId:int}

Respostas

200: OK

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"status": 403,
"detail": null,
"instance": null,
"extensions": {}
}

404: Bad Request

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/404",
"title": "BadRequest",
"status": 404,
"detail": "User not found",
"instance": null,
"extensions": {}
}

Excluir Usuário do tipo Business

https://api.premepay.com/v1/business/{businessId}/users/{userId:int}

Respostas

200: OK

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"status": 403,
"detail": null,
"instance": null,
"extensions": {}
}

404: Bad Request

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/404",
"title": "BadRequest",
"status": 404,
"detail": "User not found",
"instance": null,
"extensions": {}
}
Listar Consumidores
https://api.premepay.com/v1/store/{storeId}/users

Respostas

200: OK

[
{
"id": 43,
"name": "Rafael Henrique",
"username": "[email protected]",
"password": "*******",
"confirmPassword": null,
"countCaracteres": 0,
"permission": {
"id": 60,
"userId": 43,
"user": null,
"entityId": 9,
"entityType": "Store",
"role": 3
}
},
{
"id": 44,
"name": "João Henrique",
"username": "[email protected]",
"password": "*******",
"confirmPassword": null,
"countCaracteres": 0,
"permission": {
"id": 60,
"userId": 43,
"user": null,
"entityId": 9,
"entityType": "Store",
"role": 3
}
}
]

403: Forbidden

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/403",
"title": "Forbidden",
"status": 403,
"detail": null,
"instance": null,
"extensions": {}
}

404: Bad Request

Esta é a resposta para os casos em que a solicitação foi proibida. Isso acontece quando o servidor consegue entender o pedido da requisição, mas não autoriza a emissão de uma resposta de aprovação.
{
"type": "https://httpstatuses.com/404",
"title": "BadRequest",
"status": 404,
"detail": "User not found",
"instance": null,
"extensions": {}
}
Copy link
Outline
Adicionar Usuário
Excluir Usuário do tipo Store
Excluir Usuário do tipo Business