Oferecer a API aos seus clientes

Seus clientes podem automatizar os links deles do mesmo jeito que você automatiza sua conta de parceiro. Esta página é o manual para transformar a API em um recurso do seu produto — incluindo o texto que você pode adaptar para a sua própria documentação para desenvolvedores.

Como funciona

• Os clientes criam as próprias chaves. Todo espaço de trabalho em um plano com acesso à API tem Configurações → Chaves de API no painel com a sua marca. As chaves pertencem ao espaço de trabalho: a sua chave de parceiro nunca entra em jogo, e um cliente só alcança os próprios dados.
• O host é compartilhado. Todas as requisições vão para https://api.linkprofit.com/v1. Na v1 não há domínio de API próprio por parceiro — documente o host como o endpoint técnico do seu serviço. As respostas não levam nenhuma marca da LinkProfit: os domínios, links e analytics dos payloads são os do seu cliente.
• Você controla quem tem acesso. O acesso à API é a flag api_access nos planos que você vende. Clientes em planos sem essa flag recebem 403 plan_restricted — um momento limpo de upsell. Os limites de requisições acompanham a chave, então um plano mais robusto pode sair com um limite maior.

O que colocar na sua documentação

Uma página mínima para desenvolvedores dos seus clientes precisa de quatro coisas:

1. Onde ficam as chaves — “Configurações → Chaves de API no seu painel; a chave é exibida uma única vez”.
2. A URL base — https://api.linkprofit.com/v1, com autenticação via Authorization: Bearer <key>.
3. Um início rápido — copie o Início rápido e troque o domínio de exemplo por um dos seus.
4. A referência — aponte para a referência interativa ou hospede o arquivo OpenAPI (https://linkprofit.com/openapi.json) na sua própria ferramenta de documentação; ele é renderizado no Scalar, Swagger UI, Redoc e Postman como está.

Webhooks para clientes

Os espaços de trabalho dos clientes registram os próprios endpoints de webhook para eventos de link, de domínio e de limite de cliques. Os eventos de nível de parceiro — assinaturas, pagamentos — ficam nos seus endpoints de parceiro e nunca são entregues aos clientes.

Limites que vale mencionar

• As chaves são por espaço de trabalho: um cliente de agência que gerencia vários espaços de trabalho cria uma chave em cada um.
• A trilha de auditoria atribui as alterações feitas pela API à chave, e o cliente vê isso no painel dele — as conversas com o suporte começam por fatos.
• Tudo o que a API escreve obedece às mesmas cotas de plano do painel: um cliente não consegue driblar por script o limite de links que você vendeu a ele.