Documentação / Visão geralv1.0.0

REST API · DOCUMENTAÇÃO

Uma API simples.
Integrações mais claras.

Esta página apresenta exemplos ilustrativos de endpoints REST, métodos HTTP e respostas JSON. Os exemplos são documentais e não executam requisições reais.

BASE URL DE EXEMPLOhttps://api.hugocharlys.duckdns.org/v1
01

Autenticação

Exemplo de como uma aplicação poderia solicitar um token.

POST/auth/loginExemplo

Envia as credenciais de acesso no corpo da requisição.

REQUEST BODY
{
  "email": "usuario@exemplo.com",
  "senha": "sua-senha"
}
RESPOSTA ILUSTRATIVA · 200 OK
{
  "token": "exemplo-de-token",
  "tipo": "Bearer",
  "expiraEm": 3600
}
02

Usuários

Exemplos de operações comuns de leitura e criação.

GET/usersListar usuários

Retorna uma lista fictícia de usuários.

RESPOSTA ILUSTRATIVA · 200 OK
{
  "dados": [
    { "id": 1, "nome": "Ana Souza" },
    { "id": 2, "nome": "Lucas Lima" }
  ],
  "total": 2
}
GET/users/{id}Buscar usuário

Consulta um usuário pelo identificador informado na URL.

POST/usersCriar usuário

Envia os dados de um novo usuário para criação.

03

Status da API

Informações gerais do serviço demonstrativo.

Documentação disponível

O servidor web está entregando esta página por HTTPS. Os endpoints listados são exemplos e não representam uma API funcional.

ONLINE · SITE