Introdução a API

Autenticação

Cartões para testes

Estabelecimentos

Usuários

Consumidores

Cartão

Links de pagamento

Códigos de Erro

Split de Pagamento

Produtos

Cupons de Desconto

Vendas

Assinaturas

Financeiro

Webhooks

Nesta página

POST Adicionar usuário

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

Siga a rota acima para realizar uma requisição e adicionar um novo usuário para utilizar a API. Você vai precisar enviar a requisição contendo alguns campos obrigatórios. Abaixo, você pode visualizar nossa Lista de Descrição de Campos para Adicionar Usuário.

<aside> <img src="/icons/light-bulb_red.svg" alt="/icons/light-bulb_red.svg" width="40px" /> Usuários do tipo Business possuem acesso a todas as Stores que estejam associadas a um Business, enquanto usuários do tipo Store, possuem acesso somente a Store em que este foi associado.

</aside>

Lista de Parâmetros

Parâmetro Tipo Descrição Obrigatório
name string Nome Sim
username email E-mail Sim
password string Senha Sim
permission object Permissão Não
entityId int Identificador Sim
entityType string Store ou Business Sim
role int Nivel de Permissão Sim

Role está relacionado ao nível de acesso do usuário e aceita os seguintes valores do tipo integer:

EntityId é o id da store ou business em que o usuário terá acesso.

Role Nivel de Permissão
0 Owner
1 Administrator
2 Agent
3 ViewOnly
4 API

Exemplo de requisição para criação de usuários do tipo Business

Este é um exemplo de como a sua requisição deve parecer para a criação de usuários do tipo Business.

Respostas

Caso a sua requisição seja bem sucedida, você irá receber o retorno do objeto do usuário.

Caso sua requisição tenha os parâmetros de criação inválidos - por exemplo, especificando um campo ou um valor inválido - você pode receber como resposta o retorno de um erro. Veja abaixo a lista completa de respostas possíveis.

Exemplo de requisição para criação de usuários do tipo Store

Este é um exemplo de como a sua requisição deve parecer para a criação de usuários do tipo Store.

Respostas

Caso a sua requisição seja bem sucedida, você irá receber o retorno do objeto do usuário.

Conteúdo Relacionado

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" width="40px" /> PUT - Editar Usuários

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Obter Usuário

</aside>