REST · OpenAPI 3.1
Uma API para tudo
Cada ação no painel é um endpoint REST documentado. Bearer tokens para sessões interativas, chaves de API de longa duração com scopes para automação (a partir do plano Basic) e webhooks assinados com HMAC que avisam você sobre os eventos. Procurando o painel em si? Ele fica em deck.linkharbor.com.
curl -X POST https://dock.at-harbor.com/v1/ingest/$ID \ -H "Authorization: Bearer $INGEST_SECRET" \ -H "Content-Type: application/json" \ -d '{ "event": "player.joined", "data": { "player": "Steve" }, "state": { "type": "game_server", "online": true, "players_online": 7, "players_max": 40 } }'
Famílias de endpoints
cadastro (com data de nascimento e consentimento), login, refresh, logout, redefinição de senha, verificação de alteração de e-mail, login com Google ou Facebook, desafio de dois fatores, troca de chave de API → Bearer
perfil, alteração de e-mail e senha (senha antiga obrigatória), perfil de cobrança, tokens de dispositivo para push, configuração, verificação, códigos de recuperação e desativação dos dois fatores
direitos do plano, uso por métrica, membros com funções, convites, transferência da propriedade para outro membro, nível de proteção padrão, modelos personalizados, segredos de callback, chaves de API
criar, listar, atualizar, excluir, disponibilidade de handle, versões, publicar, SEO por página, visibilidade (pública, privada, senha), uploads
ler e alterar o rascunho, validar antes de publicar, tokens de pré-visualização para o iframe
criar, reordenar, ativar, agendar, regras de país e de dispositivo, nível de proteção por link
blocos de texto, imagem, incorporação, horário de funcionamento, cupom, contato, aviso, janela de informação, formulário, Apoiar e integração; esquemas de blocos; uploads multipart vinculados a slots do modelo; onde um arquivo é usado, antes de excluí-lo
criar links curtos em lhbr.co com slug personalizado opcional, listar e pesquisar por slug, título ou URL de destino, atualizar, excluir; estatísticas diárias de cliques (leituras de QR incluídas)
definições de formulários, endpoint público de envio, lista de envios com paginação por cursor, exportação CSV
assinar page.published, form.submitted, domain.verified e domain.disabled; entregas assinadas com HMAC, rotação de segredos, entrega de teste, reenvio manual
adicionar um domínio personalizado, verificar por DNS, páginas na raiz e abaixo dela
visualizações, cliques, visitantes únicos e taxa de cliques por página, link e bloco; análises por país, dispositivo, origem e campanha; conversões
enviar uma notificação push aos seguidores, uso em relação ao limite semanal, histórico; regras de push disparadas por eventos de integrações
seguir e deixar de seguir, listar com contagens de não lidos, coleções, busca nas páginas seguidas
conectar Instagram, TikTok, Spotify, YouTube, Twitch, GitHub, GitLab, RSS / Podcast, Google Places, Yelp, Match Day, Shopify, WooCommerce, Eventbrite, Ticket Tailor, Ticketmaster, Calendly, Calendar (iCal), Careers Page ou Custom (API); status dos widgets; histórico de eventos
busca pública de páginas com tolerância a erros de digitação e ordenação por prefixo
preços localizados, Stripe Checkout, portal do cliente, onboarding do Stripe Connect para o bloco Apoiar
Verificação de disponibilidade em / e /health. As páginas públicas e os redirecionamentos /go são entregues pela rede edge, não por este host da API.
Chamadas comuns
curl "https://dock.at-harbor.com/v1/discover/pages?q=jane" \
-H "Authorization: Bearer $LH_TOKEN"curl "https://dock.at-harbor.com/v1/plans?country=DE¤cy=EUR&has_vat_id=true"curl "https://dock.at-harbor.com/v1/pages/available?handle=myname"curl -X POST https://dock.at-harbor.com/v1/token \
-H "Content-Type: application/json" \
-d '{"key_id":"6F668EA6598B0692","key_secret":"lt_..."}'curl -X POST https://dock.at-harbor.com/v1/pages \
-H "Authorization: Bearer $LH_TOKEN" \
-H "Content-Type: application/json" \
-d '{"handle":"myname","template_key":"creator"}'curl -X PATCH https://dock.at-harbor.com/v1/pages/42/draft \
-H "Authorization: Bearer $LH_TOKEN" \
-d '{"config":{"profile_name":"Jane"},"theme_config":{"button_style":"pill","font":"Sora"}}'curl -X POST https://dock.at-harbor.com/v1/pages/42/links \
-H "Authorization: Bearer $LH_TOKEN" \
-d '{"title":"DE Store","target_url_template":"https://shop.de/...","geo":{"mode":"allowlist","countries":["DE","AT"]}}'curl -X POST https://dock.at-harbor.com/v1/pages/42/publish \
-H "Authorization: Bearer $LH_TOKEN"curl https://dock.at-harbor.com/v1/pages/42/versions/7 \
-H "Authorization: Bearer $LH_TOKEN"curl -X POST https://dock.at-harbor.com/v1/users/me/device-tokens \
-H "Authorization: Bearer $LH_TOKEN" \
-d '{"token":"fcm_...","platform":"android"}'curl https://dock.at-harbor.com/v1/workspaces/me/usage \
-H "Authorization: Bearer $LH_TOKEN"curl -X POST https://dock.at-harbor.com/v1/workspaces/me/callback-secrets/3/rotate \
-H "Authorization: Bearer $LH_TOKEN"
Referência completa
Especificação OpenAPI 3.1 em https://dock.at-harbor.com/openapi.yaml
Documentação interativa em docs.linkharbor.com
Scopes das chaves de API
read:pageswrite:pagesread:linkswrite:linksread:assetswrite:assetsread:formswrite:formsread:workspaceswrite:workspacesread:short_linkswrite:short_linksread:statsread:donationswrite:templates write:X inclui automaticamente read:X para o mesmo recurso. Estatísticas e pagamentos de apoiadores são só de leitura, modelos do espaço de trabalho só de escrita. As chaves de API estão disponíveis a partir do plano Basic (2 chaves), o Pro tem 5, o Agency 20, o Enterprise 50. O scope de páginas cobre rascunho, SEO, versões e blocos de conteúdo; links e uploads têm scopes próprios.
Limites de requisições
POST /v1/token, a troca de uma chave de API por um Bearer token. A primeira chamada de qualquer integração.
Bucket padrão para todas as chamadas autenticadas: páginas, links, blocos, formulários, links curtos, estatísticas. As chamadas sem token compartilham o bucket público, 120 por minuto por IP.
GET /v1/discover/pages, a busca pública. Contado por usuário, por IP sem login.
Contados por espaço de trabalho para chaves de API, por usuário para sessões do painel, por IP nos demais casos, e não por plano. Todas as respostas trazem X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Bucket; um 429 inclui Retry-After. Os buckets são renovados a cada minuto. Auth, inscrições e callbacks de venda têm buckets próprios, mais apertados, com o mesmo formato.
As chaves de API e os webhooks vêm com o Basic; veja planos e limites. A forma como tokens, chaves e dados são protegidos está na página de segurança. Cria páginas para clientes? Leia LinkHarbor para agências ou veja todos os recursos que a API cobre.