MAPA DE NAVEGAÇÃO DA API

O mundo de One Piece,
na ponta dos seus dedos.

Personagens, tripulações, Akuma no Mi e recompensas. Consulte os dados da Grand Line em uma API simples e direta.

Explorar endpoints ↓

RESTFORMATO

JSONRESPOSTA

JWTAUTENTICAÇÃO

PRIMEIROS PASSOS

Uma chamada e você já está navegando.

Comece com a lista de personagens.
Sem complicação, direto ao ponto.

REQUISIÇÃO DE EXEMPLO

$curl -s 'https://onepiece-api.petisquinho.com/api/characters?limit=5'

RESPOSTA 200 OK

{
  "status": "success",
  "data": {
    "characters": [{ "name": "Monkey D. Luffy", "bounty": 3000000000 }],
    "pagination": { "total": 67, "page": 1, "limit": 5, "totalPages": 14 }
  }
}

REFERÊNCIA

Endpoints

Rotas públicas para consulta e rotas protegidas para administrar o catálogo.

◎

Consulta pública

Disponível sem autenticação

03 ROTAS

GET/api/charactersPÚBLICO

Lista personagens. Aceita filtros por nome, tripulação, Akuma no Mi e recompensa; os resultados são paginados.

EXEMPLO/api/characters?crew=Marinha&limit=10

GET/api/characters/searchPÚBLICO

Busca texto em nome, descrição, tripulação e Akuma no Mi. O parâmetro q é obrigatório.

EXEMPLO/api/characters/search?q=luffy

GET/api/characters/{id}PÚBLICO

Retorna os detalhes de um personagem pelo ID UUID.

PARÂMETROid — UUID do personagem

⌑

Administração

Requer token Bearer de administrador

06 ROTAS

POST/api/admin/authPÚBLICO

Autentica um administrador e devolve um token JWT.

BODY JSON{ "email": "...", "password": "..." }

POST/api/characters▣ PROTEGIDO

Cria um personagem. Aceita JSON ou multipart/form-data com imagem JPEG/PNG de até 2 MB.

PUT/api/characters/{id}▣ PROTEGIDO

Atualiza os campos enviados e, opcionalmente, substitui a imagem.

DELETE/api/characters/{id}▣ PROTEGIDO

Remove um personagem e a imagem enviada que pertence a ele.

POST/api/admin▣ PROTEGIDO

Cria outro administrador autenticado.

GET/api/admin/profile▣ PROTEGIDO

Retorna o perfil do administrador associado ao token.

LISTAGEM DE PERSONAGENS

Filtros e paginação

Use estes parâmetros em GET /api/characters.

nameTrecho do nome (3–100 caracteres)

crewTrecho da tripulação (3–100 caracteres)

hasDevilFruittrue ou false

minBounty / maxBountyFaixa de recompensa a partir de 0

pagePágina desejada (padrão: 1)

limitItens por página, de 1 a 100 (padrão: 10)

✳

Sobre recompensas: bounty: 0 indica que não há recompensa conhecida. Campos sem valor, como crew, devilFruit e image, podem ser omitidos da resposta.

ÁREA RESTRITA

Credencial de administrador.
Chave para as rotas privadas.

Envie suas credenciais para receber um JWT. Inclua o token no cabeçalho das chamadas protegidas.

⌑

O login permite até 10 tentativas a cada 15 minutos por endereço IP.

1. AUTENTICAR

curl -X POST 'https://onepiece-api.petisquinho.com/api/admin/auth' \
  -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","password":"SuaSenha1!"}'

2. USAR O TOKEN

curl 'https://onepiece-api.petisquinho.com/api/admin/profile' \
  -H 'Authorization: Bearer SEU_TOKEN'

CONTRATO DA API

Códigos de resposta

Respostas em JSON para sucesso, validação e erros comuns.

200Consulta concluída

201Registro criado

400Validação ou ID inválido

401Token ou credenciais inválidos

404Personagem/admin não encontrado

409Nome ou e-mail já cadastrado

429Limite de tentativas excedido

Pronto para zarpar?

Consulte a rota base para ver o índice da API.

Abrir índice JSON ↗

O mundo de One Piece,na ponta dos seus dedos.