Ir para a documentação
SparkGlimSparkGlim Programadores
Pesquisar em toda a documentação

Experimente um tema na sua língua ou um caminho API exato.

    Referência API

    Detalhe de artigo publicado

    Devolve artigo publicado e até quatro relacionados, e incrementa visualizações.

    GEThttps://api.sparkglim.net/api/public/blog/:slug

    Modelo de acesso

    Modelo de acesso
    Acesso público com validação
    Disponibilidade documentada
    Implementado no código

    Disponibilidade verificada no código, sem garantia de produção.

    Abra o URL de pagamento devolvido. O SparkGlim Server controla preços, métodos, verificação e entrega; o regresso do navegador apenas navega.

    Ler um artigo incrementa as visualizações. Este GET não é uma inspeção sem alterações.

    Parâmetros

    NomeTipoValidação
    slugObrigatório

    Identificador de URL da campanha ou artigo publicado existente.

    stringValidação: Identificador URL público.

    Pedido

    Os exemplos descrevem o contrato e não são executados. Use registos de teste autorizados; nunca cole segredos reais aqui.

    GET /api/public/blog/:slug
    http
    GET /api/public/blog/example-campaign HTTP/1.1
    Host: api.sparkglim.net
    

    Resposta

    Resposta de sucesso · HTTP 200
    json
    {
      "success": true,
      "data": {
        "post": {
          "id": "11111111-1111-4111-8111-111111111111",
          "slug": "example-article",
          "title": "Example article",
          "status": "published"
        },
        "relatedPosts": []
      }
    }
    Resposta de erro · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validação, permissões, registos indisponíveis e falhas usam estado HTTP e erro do controlador.

    Limites e novas tentativas

    Limite padrão: 100 pedidos por IP em 60 segundos. Aplicam-se também controlos específicos.

    Compatibilidade do código

    As operações autorizadas exigem testes específicos da conta.

    • server/src/api/router.ts
    • server/src/api/routes/public.ts