Skip to content

Template

Operações relacionadas a templates de processos

Operations

Retorna o HTML de um template pelo nome

Request

Retorna o conteúdo HTML de um template de processo a partir do seu nome. O nome do template segue o padrão {Cidade}/{NomeArquivo}.html (ex: MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html).

Seleção da versão:

  • Usa a versão ativa (actual_version) quando existir e tiver HTML válido
  • Caso contrário, utiliza a última versão (maior índice) com HTML válido
  • Permite fallback quando actual_version está ausente ou aponta para versão sem conteúdo

Validação de HTML:

  • Retorna 404 quando o HTML está vazio, nulo ou contém apenas espaços em branco

Possíveis erros 404:

  • Template não encontrado no banco
  • Template sem versões
  • Template sem HTML válido (vazio ou inexistente) em nenhuma versão
Security
InternalAuth
Query
namestringrequired

Nome do template no formato {Cidade}/{NomeArquivo}.html.

Example:name=MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html
GET
/hub-api/template
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/template?name=MogidascruzesSP%2FAlvara_Aprovacao_Execucao_Projetos.html' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Template encontrado com sucesso

Bodyapplication/json
namestring

Nome do arquivo de template

Example:"MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html"
htmlstring

Conteúdo HTML completo da versão do template (nunca vazio)

Example:"<!DOCTYPE html><html><head><title>Alvará de Aprovação</title></head><body>...</body></html>"
created_at_isostring or null

Data de criação da versão retornada (ISO 8601)

Example:"2025-08-15T14:30:00.000Z"
fromstring or null

Autor ou origem da versão retornada

Example:"admin@cidade.gov.br"
Response
{
  "name": "MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html",
  "html": "<!DOCTYPE html><html><head><title>Alvará de Aprovação</title></head><body>...</body></html>",
  "created_at_iso": "2025-08-15T14:30:00.000Z",
  "from": "admin@cidade.gov.br"
}