Visão geral da API
API REST v1 para links, analytics, domínios e operações de parceiro: URL base, tipos de chave, escopos e o modelo white-label.
Atualizado em 13 de agosto de 2026
Tudo o que o painel faz, a API também faz: criar links com segmentação e splits A/B, ler analytics, conectar domínios, gerenciar clientes e planos. A API é uma superfície de produto de primeira classe — o painel e a API executam o mesmo código e aplicam os mesmos limites.
URL base
https://api.linkprofit.com/v1
Todas as requisições usam HTTPS e JSON. As respostas são JSON, exceto a imagem do QR code e a exportação CSV. A referência interativa e sempre atualizada fica em /docs/api/reference, gerada a partir dos mesmos esquemas que validam cada requisição.
Dois tipos de chave
| Prefixo da chave | Escopo | Criada em | Dá acesso a |
|---|---|---|---|
| lp_live_… | Espaço de trabalho | Configurações do espaço de trabalho → Chaves de API | /links, /analytics, /domains, /workspace, /events, /webhooks |
| lpp_live_… | Parceiro | Configurações do parceiro → Chaves de API | /partner/* e /webhooks |
Uma chave de espaço de trabalho atua dentro de um espaço de trabalho de cliente. Uma chave de parceiro gerencia a conta do parceiro: clientes, planos, domínios, pagamentos. As chaves carregam escopos que limitam o que cada uma pode fazer.
Versionamento
A v1 está congelada: os campos só são adicionados, nunca renomeados ou
removidos. Mudanças incompatíveis sairiam como /v2. Programe contra os campos
documentados e ignore os desconhecidos.
White-label: oferecer a API aos seus clientes
Se você opera um serviço de links white-label, a API faz parte do que você revende:
- As chaves são suas para distribuir. Cada cliente cria chaves de espaço de trabalho no painel com a marca dele (Configurações → Chaves de API) — você nunca compartilha a sua chave de parceiro.
- O host continua compartilhado. Na v1, todo o tráfego da API vai para
api.linkprofit.com— um domínio de API próprio por parceiro ainda não está disponível. Documente a URL base como “o host da API do seu serviço”; as respostas não levam nenhuma marca da LinkProfit. - Os limites seguem os seus planos. O acesso à API é um indicador de recurso
nos planos que você vende (
api_access), e o limite de requisições de cada chave vem do plano. Um cliente em um plano sem acesso à API recebe403 plan_restricted.
Veja o guia de white-label para uma página pronta para copiar e adaptar à sua própria documentação para desenvolvedores.
Referências rápidas
- Início rápido — crie um link em dois minutos.
- Autenticação — chaves, escopos, rotação de chaves.
- Paginação — cursores em todo endpoint de listagem.
- Erros — o formato único de erro e todos os códigos.
- Limites de requisições — janela deslizante, cabeçalhos, novas tentativas.
- Webhooks — entregas de eventos assinadas e com novas tentativas.