Endpoints da REST API
Caution
Página de demonstração - Esta é uma página de demonstração para mostrar o recurso de documentação com várias abas. Este conteúdo serve apenas para ilustração.
Nossa REST API oferece endpoints para acessar e manipular dados. Todos os endpoints retornam dados em formato JSON.
URL base
Todas as requisições à API devem ser feitas para a seguinte URL base:
https://api.example.com/v1Endpoints de usuários
Listar todos os usuários
GET /usersRetorna a lista de todos os usuários. Aceita parâmetros de paginação.
Parâmetros de consulta:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| page | integer | Número da página (padrão: 1) |
| limit | integer | Quantidade de registros por página (padrão: 50, máximo: 100) |
| sort | string | Campo usado na ordenação (por exemplo, “name”, “created_at”) |
Resposta:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Buscar usuário por ID
GET /users/{id}Retorna um único usuário pelo ID.
Resposta:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Endpoints de produtos
Listar todos os produtos
GET /productsRetorna a lista de todos os produtos. Aceita filtros e paginação.
Parâmetros de consulta:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| category | string | Filtra por categoria |
| min_price | number | Filtra pelo preço mínimo |
| max_price | number | Filtra pelo preço máximo |
| page | integer | Número da página (padrão: 1) |
| limit | integer | Quantidade de registros por página (padrão: 50, máximo: 100) |
Resposta:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Tratamento de erros
Todos os endpoints seguem os códigos de status HTTP padrão e trazem mensagens de erro detalhadas quando faz sentido:
| Código de status | Descrição |
|---|---|
| 200 | OK - Requisição bem-sucedida |
| 400 | Bad Request - Parâmetros inválidos |
| 401 | Unauthorized - Autenticação necessária |
| 403 | Forbidden - Permissões insuficientes |
| 404 | Not Found - O recurso não existe |
| 429 | Too Many Requests - Limite de requisições excedido |
| 500 | Internal Server Error - Ocorreu um erro no servidor |
As respostas de erro trazem uma mensagem explicando o que deu errado:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}