Documentação da API

Documentação completa da API REST do PosiLinks para desenvolvedores

Introdução

A API do PosiLinks é uma API REST que permite gerenciar usuários, páginas de links, links individuais e analytics. Todas as respostas são em formato JSON.

Base URL:

https://api.posilinks.com

Autenticação

A API utiliza autenticação via JWT (JSON Web Token). Inclua o token no header Authorization:

Authorization: Bearer YOUR_JWT_TOKEN

Alguns endpoints são públicos e não requerem autenticação.

Endpoints Disponíveis

Lista completa de todos os endpoints da API

GET/api/users
Auth

Listar todos os usuários

POST/api/users

Criar novo usuário

GET/api/users/{id}
Auth

Obter usuário por ID

PUT/api/users/{id}
Auth

Atualizar usuário

DELETE/api/users/{id}
Auth

Deletar usuário

GET/api/pages
Auth

Listar páginas do usuário

POST/api/pages
Auth

Criar nova página

GET/api/pages/{id}
Auth

Obter página por ID

PUT/api/pages/{id}
Auth

Atualizar página

DELETE/api/pages/{id}
Auth

Deletar página

GET/api/links
Auth

Listar links da página

POST/api/links
Auth

Criar novo link

PUT/api/links/{id}
Auth

Atualizar link

DELETE/api/links/{id}
Auth

Deletar link

GET/api/analytics
Auth

Obter analytics da página

Exemplos de Uso

Exemplos práticos de como usar a API

Criar Usuário

Requisição:

POST /api/users Content-Type: application/json { "name": "João Silva", "email": "joao@exemplo.com", "username": "joaosilva", "password": "senha123" }

Resposta:

{ "id": "user_123", "name": "João Silva", "email": "joao@exemplo.com", "username": "joaosilva", "plan": "FREE", "createdAt": "2024-01-15T10:30:00Z" }

Criar Página de Links

Requisição:

POST /api/pages Authorization: Bearer YOUR_JWT_TOKEN Content-Type: application/json { "title": "Meus Links", "description": "Todos os meus links importantes", "theme": "default", "customization": { "backgroundColor": "#ffffff", "textColor": "#000000" } }

Resposta:

{ "id": "page_456", "title": "Meus Links", "description": "Todos os meus links importantes", "slug": "joaosilva", "theme": "default", "isActive": true, "createdAt": "2024-01-15T10:35:00Z" }

Interface Swagger

Explore e teste todos os endpoints da API usando nossa interface Swagger interativa.

Pronto para começar?

Crie sua conta gratuita e comece a usar nossa API hoje mesmo. Documentação completa e suporte técnico incluídos.