Skip to main content

​
Introdução

Nesta seção, são apresentados os endpoints de administração da API da Ponto-On. Esses endpoints são projetados para fornecer funcionalidades administrativas específicas, como gerenciamento de usuários, configurações de sistema e operações relacionadas à conta.

​
Aviso Importante

Por se tratar de operações administrativas que lidam com dados críticos, como informações de pagamento (Stripe), criação de produtos e configurações sensíveis, é fundamental utilizar esses endpoints com cautela. Certifique-se de ter os privilégios e autorizações adequados antes de acessá-los. Além disso, recomendamos realizar testes em ambientes de desenvolvimento antes de aplicar qualquer alteração em produção.

​
Endpoint: /admins/

Este endpoint permite realizar operações de gerenciamento de usuários administrativos, como criação, atualização e exclusão de contas de administradores e funcionários.

​
Métodos HTTP Suportados:

  • GET: Obter informações sobre usuários administrativos.
  • POST: Criar um novo usuário administrativo.
  • PUT: Atualizar os detalhes de um usuário administrativo existente.
  • DELETE: Remover um usuário administrativo do sistema.

​
Exemplo de Uso:

# Obter informações sobre todos os usuários administrativos
curl --location --request GET 'https://api.ponto-on.com/admins/'

# Criar um novo usuário administrativo
curl --location --request POST 'https://api.ponto-on.com/admin/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome": "Nome do Administrador",
    "email": "admin@example.com",
    "senha": "senha123",
    "role": "admin"
}'

# Atualizar os detalhes de um usuário administrativo existente
curl --location --request PUT 'https://api.ponto-on.com/admin/1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome": "Novo Nome do Administrador",
    "email": "novoadmin@example.com"
}'

# Remover um usuário administrativo do sistema
curl --location --request DELETE 'https://api.ponto-on.com/admin/1'