Documentação da API — Atlas da Notícia

Atualizada em 8 jul. 2026 com base no código atual da API (voltdatalab/api-atlasdanoticia, branch caprover, commit da433d4) e conferência de endpoints em produção (https://api.atlas.jor.br).

Visão geral

A API do Atlas da Notícia é uma API REST versionada. A versão pública principal continua em v1.

• Base da API: https://api.atlas.jor.br/api/v1
• Formato de retorno: JSON
• Autenticação: JWT no header Authorization, com esquema Bearer e o JWT emitido pela API.
• Cadastro de usuário: https://api.atlas.jor.br/register?ref=atlas.jor.br

Alguns endpoints são públicos, mas a maioria exige JWT. Há também um token “dummy” público para consultas específicas, descrito abaixo.

1. Autenticação

Login

POST https://api.atlas.jor.br/api/v1/auth/login
Content-Type: application/json

{
  "email": "seu@email",
  "password": "sua senha"
}

Resposta:

{
  "access_token": "seu_token",
  "token_type": "bearer",
  "expires_in": 3600
}

Use o token nas próximas requisições:

Authorization: <Bearer JWT_AQUI>

Renovar token

POST https://api.atlas.jor.br/api/v1/auth/refresh
Authorization: <Bearer JWT_AQUI>

Retorna um novo JSON no mesmo formato do login.

Logout

POST https://api.atlas.jor.br/api/v1/auth/logout
Authorization: <Bearer JWT_AQUI>

Resposta:

{
  "message": "Successfully logged out"
}

Token público para consultas online

A API também possui um endpoint público que retorna um JWT de usuário técnico/dummy:

GET https://api.atlas.jor.br/api/v1/auth/dummy-jwt

Esse token permite acessar endpoints liberados para a role dummy, como GET /media/online e os endpoints de dados em /data/*.

2. Filtros e seleção de campos

Os endpoints de dados em /data/* aceitam filtros usando os campos retornados por suas rotas /definitions.

Tipos de filtro

Seleção de campos

Use field[] para limitar os campos retornados:

GET /data/analytic?field[]=id&field[]=nome_veiculo&field[]=estado

Campos não listados por /definitions são ignorados.

3. Endpoints públicos e semipúblicos da v1

4. Endpoints de dados (/data)

Todos os endpoints abaixo exigem JWT. É possível usar o token retornado por /auth/dummy-jwt quando a consulta for pública.

Cada endpoint possui uma rota /definitions, que retorna os campos disponíveis para filtro e seleção.

4.1 Veículos — Atlas Analytic

GET /data/analytic
GET /data/analytic/definitions

Descrição: lista veículos jornalísticos com dados principais e relações como modelos de negócio, características, colaboradores e canais.

Campos disponíveis em produção:

[
  "id",
  "nome_veiculo",
  "media_source_id",
  "fonte",
  "segment_id",
  "segmento",
  "city_id",
  "cidade",
  "cod_mun_ibge",
  "state_id",
  "estado",
  "region_id",
  "regiao",
  "address",
  "annotations",
  "email",
  "employees_range_id",
  "num_funcionarios",
  "periodicity",
  "another_periodicity",
  "eh_jornal",
  "eh_site_pago",
  "data_fechamento",
  "ativo",
  "data_inclusao"
]

Exemplo:

GET /data/analytic?estado=SP&field[]=id&field[]=nome_veiculo&field[]=cidade&field[]=estado
Authorization: <Bearer JWT_AQUI>

4.2 Pesquisa — Atlas Analytic Research

GET /data/analytic_research

Descrição: endpoint alternativo de dados analíticos para pesquisa.

Observação: há método no controller para definições (analyticResearchDefs), mas a rota /data/analytic_research/definitions não está registrada no código atual. Em produção, essa rota não deve ser documentada como disponível até ser registrada em routes/api.php.

4.3 Cidades sem veículos

GET /data/cities-without-media
GET /data/cities-without-media/definitions

Campos:

[
  "codmun",
  "municipio",
  "uf",
  "regiao",
  "populacao",
  "ano_populacao",
  "IDHM",
  "IDHM_R",
  "IDHM_E"
]

4.4 IDHM médio por UF e região

GET /data/med-idhm-2010-state-region
GET /data/med-idhm-2010-state-region/definitions

Campos:

[
  "estado",
  "regiao",
  "med_idhm",
  "med_idhm_e",
  "med_idhm_r",
  "populacao",
  "qtd_veiculos",
  "veiculos_por_100k_hab",
  "ano_populacao"
]

4.5 Quantidade de cidades sem veículos por região

GET /data/qtd-cities-without-media-region
GET /data/qtd-cities-without-media-region/definitions

Campos:

[
  "estado",
  "qtd_cidades",
  "qtd_desertos"
]

4.6 Quantidade de cidades sem veículos por estado

GET /data/qtd-cities-without-media-state
GET /data/qtd-cities-without-media-state/definitions

Campos:

[
  "estado",
  "qtd_cidades",
  "qtd_desertos"
]

4.7 Quantidade de cidades sem veículos por estado e região

GET /data/qtd-cities-without-media-state-region
GET /data/qtd-cities-without-media-state-region/definitions

Campos:

[
  "estado",
  "regiao",
  "qtd_desertos"
]

4.8 Quase desertos

GET /data/almost-deserts
GET /data/almost-deserts/definitions

Descrição: municípios com poucos veículos jornalísticos.

Campos:

[
  "cidade",
  "estado",
  "regiao",
  "qtd_veiculos",
  "codmun_ibge",
  "populacao",
  "ano_populacao",
  "veiculos_por_100k_hab",
  "IDHM",
  "IDHM_R",
  "IDHM_E"
]

4.9 Veículos por 100 mil habitantes

GET /data/medias-100k-hab
GET /data/medias-100k-hab/definitions

Campos:

[
  "cidade",
  "estado",
  "regiao",
  "qtd_veiculos",
  "codmun_ibge",
  "populacao",
  "ano_populacao",
  "veiculos_por_100k_hab",
  "IDHM",
  "IDHM_R",
  "IDHM_E"
]

5. Veículos online e veículos verificados

Listar veículos online

GET /media/online
Authorization: <Bearer JWT_AQUI>

Aceita filtro opcional por nome:

GET /media/online?name=acre
Authorization: <Bearer JWT_AQUI>

Campos retornados:

[
  {
    "id": 13960,
    "name": "ACRELANDIA NEWS",
    "city": "Acrelândia",
    "state": "AC"
  }
]

Listar veículos verificados

GET /media/verified

Não exige autenticação. Aceita filtro opcional:

GET /media/verified?search=jornal

Retorna veículos com criterios >= 8 a partir da view v_atlas_qtd_criterios_veiculos.

Campos principais observados em produção:

[
  {
    "id": 1969,
    "nome": "JORNAL ATUAL",
    "cidade": "Itaguaí",
    "estado": "RJ",
    "regiao": "Sudeste",
    "cod_municipio": "3302007",
    "ultima_atualizacao": "2026-04-16 14:46:04",
    "criterios": 12,
    "expediente": "sim",
    "expediente_url": "https://...",
    "principiosEditoriais": "sim",
    "principiosEditoriais_url": "https://..."
  }
]

A resposta completa pode incluir pares de campos para critérios de transparência, como expediente/expediente_url, politicaDeCorrecao/politicaDeCorrecao_url, identificacaoDeAutoria/identificacaoDeAutoria_url, acessibilidade/acessibilidade_url etc.

6. Formulário de verificação

Enviar formulário

POST /verification-form
Content-Type: application/json

Estrutura esperada:

{
  "media_id": 123,
  "criterios": {
    "expediente": {
      "resposta": "sim",
      "url": "https://exemplo.com/expediente",
      "data": "2026-07-08",
      "observacoes": ["observação opcional"]
    }
  }
}

Validações principais:

Resposta de sucesso:

{
  "msg": "Formulário de verificação enviado com sucesso"
}

Último formulário de um veículo

GET /verification-form/{mediaId}/last

Retorna erro 400 se o veículo não estiver ativo ou não for do segmento online. Retorna 404 se não houver formulário para o veículo.

7. Sugestões de veículos

Os endpoints de sugestão exigem JWT.

Buscar veículos para sugestão/edição

GET /suggestion/all?value=termo
Authorization: <Bearer JWT_AQUI>

Retorna veículos cujo nome ou ID combine com o termo pesquisado.

Enviar sugestão de novo veículo

POST /suggestion
Authorization: <Bearer JWT_AQUI>
Content-Type: application/json

Enviar sugestão de atualização

PUT /suggestion/{mediaId}
Authorization: <Bearer JWT_AQUI>
Content-Type: application/json

Campos principais aceitos dentro de media:

Campos principais aceitos dentro de media_form:

Resposta de sucesso:

{
  "msg": "Sugestão de mídia enviada com sucesso"
}

8. Observação sobre v2

O código atual também expõe rotas em /api/v2, voltadas principalmente ao painel/admin:

• GET /api/v2/auth/me
• GET /api/v2/dashboard/*
• recursos administrativos como medias, media-forms, states, regions, sponsors, segments, media-sources, employees-ranges, collaborators, cities, features, channels, business-models

Essas rotas exigem JWT e roles específicas (api, admin, regular; algumas apenas admin/regular). Recomenda-se não apresentá-las como API pública geral sem uma documentação separada de painel/admin.

9. Exemplos com curl

Obter token dummy e consultar veículos online

JWT=$(curl -s https://api.atlas.jor.br/api/v1/auth/dummy-jwt | jq -r .access_token)

curl -H "Authorization: Bearer $JWT" \
  "https://api.atlas.jor.br/api/v1/media/online?name=acre"

Consultar definições de campos

JWT=$(curl -s https://api.atlas.jor.br/api/v1/auth/dummy-jwt | jq -r .access_token)

curl -H "Authorization: Bearer $JWT" \
  "https://api.atlas.jor.br/api/v1/data/analytic/definitions"

Consultar veículos por estado com campos selecionados

JWT=$(curl -s https://api.atlas.jor.br/api/v1/auth/dummy-jwt | jq -r .access_token)

curl -G "https://api.atlas.jor.br/api/v1/data/analytic" \
  -H "Authorization: Bearer $JWT" \
  --data-urlencode "estado=SP" \
  --data-urlencode "field[]=id" \
  --data-urlencode "field[]=nome_veiculo" \
  --data-urlencode "field[]=cidade" \
  --data-urlencode "field[]=estado"

10. Mudanças relevantes em relação à documentação antiga

• GET /auth/dummy-jwt existe e é útil para consultas públicas com token técnico.
• POST /auth/logout existe e deve ser documentado junto de login/refresh.
• GET /media/online existe, mas exige JWT com role dummy.
• GET /media/verified existe e não exige autenticação.
• Os endpoints de verification-form estão públicos no código atual.
• Os endpoints auxiliares de formulário (cities/all, segments/all, business-models/all etc.) existem e exigem JWT.
• GET /data/analytic/definitions agora inclui campos adicionais como media_source_id, IDs relacionais, ativo e data_inclusao.
• /data/analytic_research está registrado, mas /data/analytic_research/definitions não está registrado.
• Há novas validações/campos na sugestão de veículo relacionados a plataforma, audiência, cobertura, responsável jornalístico, acessibilidade e princípios editoriais.