☰
TRANSFORMAÇÃO DIGITAL
play

OUÇA A RÁDIO ROQUETTE-PINTO

94FM

Integra Dados RJ

Projeto Integra-Dados — Padronização de APIs

 

Manual de instruções para disponibilização de API's no Sistema Integra Dados

 

Sumário

1 Introdução
2 Limites de Tráfego
3 APIs-Webservices Legadas — Serviços já em Operação
4 Novas APIs — Disponibilização de novos serviços de Dados

 

1 Introdução


A fim de viabilizar o Projeto Integra-Dados (Resolução SETD n° 143/2026), este documento visa elencar requisitos técnicos necessários que as APIs/Webservices deverão conter para compor o Projeto Integra-Dados.

 

2 Limites de Tráfego


As APIs/Webservices deverão ter suas limitações de tráfego documentadas, sempre que possível, ainda que na forma de estimativa, como por exemplo: requisições/segundo, requisições/minuto, requisições/dia, entre outras.

Exemplos de estimativas:

1.    Cálculo por Média de Tráfego (Estimativa Geral)

Se você sabe quantas requisições o seu sistema recebe em um período maior (como um mês), você pode calcular a média diária:

-    Requisições por dia = Total de Requisições no Mês / Número de Dias no Mês

2.    Cálculo por Requisições por Segundo (RPS/TPS)

Se você tem dados de carga do servidor por segundos, converta para o total diário:

-    Requisições por dia = Requisições por Segundo × 86400 segundos (24h)

 

3 APIs-Webservices Legadas — Serviços já em Operação


-    As APIs/Webservices Legadas deverão ter, sempre que possível, Autenticação/Acesso do tipo API-KEY com cabeçalho e senha configuráveis. Isso permite que os recursos técnicos do PRODERJ que serão usados para gerenciar os acessos às APIs/Webservices sejam usados sem necessidade de configurações adicionais.

-    Fornecer, sempre que possível, documentação da API em formato OpenAPI 3.x com pelo menos 1 exemplo de resposta válida para cada endpoint do serviço. (Não é necessária a exposição de Swagger/Redoc; a documentação apenas deve ser entregue.)

OBS 01.: Importante citar que, no caso de APIs/Webservices já existentes, a inclusão deste tipo de Autenticação/Acesso não causa qualquer impacto no funcionamento de sistemas legados e nos sistemas/serviços já integrados a estes, pois somente será necessária a criação de uma nova funcionalidade protegida por Autenticação/Acesso do tipo API-KEY que receba parâmetros e produza respostas idênticas aos serviços que serão fornecidos, para que seja compatível.

OBS 02.: Regras de segurança adicionais como restrição de acesso por IP, por exemplo, além do acesso do tipo API-KEY, também podem ser usadas desde que acordadas previamente com o PRODERJ.

 

4 Novas APIs — Disponibilização de novos serviços de Dados


Para que Novas APIs sejam compatíveis com os recursos do projeto, devem ser atendidos os seguintes requisitos técnicos:

  • Autenticação/Acesso do tipo API-KEY com cabeçalho e senha configuráveis.
  • Parâmetros de entrada e respostas em formato JSON.
  • Fornecer documentação da API em formato OpenAPI 3.x com pelo menos 1 exemplo de resposta válida para cada endpoint do serviço. (Não é necessária a exposição de Swagger/Redoc; a documentação apenas deve ser entregue.)

OBS 01.: Regras de segurança adicionais como restrição de acesso por IP, por exemplo, além do acesso do tipo API-KEY, também podem ser usadas desde que acordadas previamente com o PRODERJ.

 

 

 

Manual de Instruções de Consumo de API's do Projeto Integra Dados


Serviços Disponibilizados à SETD


Sumário

1  Acesso

2  Urls de Autenticação

3  Urls de Acesso ao(s) Serviço(s) Solicitado(s)

4  Serviço(s) Disponibilizado(s)

5  Consumo do(s) Serviço(s) Solicitado(s)

6  Exemplos Consumo do(s) Serviço(s) Solicitado(s)

6.1  Fazer a Requisição de Autenticação

6.2  Exemplos de Resposta da Requisição de Autenticação

6.2.1  Resposta ok

6.2.2  Respostas de falha

6.3  Fazer o Consumo do(s) Serviço(s) Solicitado(s)

6.3.1  Exemplos de Resposta do Consumo do(s) Serviço(s) Solicitado(s)

6.3.1.1  ENDPOINT /proderj-rjdigital/api/cms/servicos_busca/

6.3.1.2  ENDPOINT /proderj-rjdigital/api/cms/orgaos_all/

 

1 - Acesso

Para Acesso às API's do Projeto Integra Dados, serão fornecidas 1 URL, 1 client id e 1 secret. O acesso usa o protocolo OAuth2. Um mesmo acesso poderá acesso mais de 1 serviço, depende da solicitação.

 

2 - Urls de Autenticação

As urls de autenticação estão listadas abaixo:

Homologação:
https://sistemas.idp.homol.proderj.rj.gov.br/auth/realms/sistemas/protocol/openid-connect/token


Produção
https://sistemas.idp.rj.gov.br/auth/realms/sistemas/protocol/openid-connect/token

 

3 - Urls de Acesso ao(s) Serviço(s) Solicitado(s)


As urls de acesso ao(s) serviço(s) solicitado(s) terão os seguintes formatos:

Homologação:
https://setd-2-homol-apicast-production.api-h.proderj.rj.gov.br/(servico-solicitado)

 

Produção
https://setd-prd-apicast-production.api.rj.gov.br/(servico-solicitado)

 

4 - Serviço(s) Disponibilizado(s)

Nome do Serviço         Endpoint

proderj-rjdigital            /proderj-rjdigital/api/cms/servicos_busca/

proderj-rjdigital            /proderj-rjdigital/api/cms/orgaos_all/


5 - Consumo do(s) Serviço(s) Solicitado(s)


O consumo do(s) serviço(s) solicitado(s) se dá da seguinte maneira:

1. Recuperar o access token -> a url de autenticação, o client id e o secret serão usados para recuperar o access token. O access token será usado na requiquisição de consumo do(s) serviço(s) solicitado(s).


2. De posse do access token consumir o serviço.

OBS.: A forma de consumo do(s) serviço(s) solicitado(s) e as respostas variam conforme o serviço solicitado.


6 - Exemplos Consumo do(s) Serviço(s) Solicitado(s)


Abaixo, segue um exemplo simples de consumo do(s) serviço(s) solicitado(s) usando o programa curl.

 

6.1 - Fazer a Requisição de Autenticação


curl -X POST \ 'https://sistemas.idp.homol.proderj.rj.gov.br/auth/realms/sistemas/protocol/openid
-connect/token' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={SEU_CLIENT_ID}' \
--data-urlencode 'client_secret={SEU_CLIENT_SECRET}'


6.2 - Exemplos de Resposta da Requisição de Autenticação


6.2.1 - Resposta ok

{
"access_token": "eyJhbGciOiJSUzI1NiIsInR6...", "expires_in": 300,
"refresh_expires_in": 0, "token_type": "Bearer",
"not-before-policy": 1720203349, "scope": "email profile"
}

 

6.2.2 Respostas de falha

{
"error": "invalid_client",
"error_description": "Invalid client or Invalid client credentials"
}
 

{
"error": "unauthorized_client",
"error_description": "Invalid client or Invalid client credentials"
}


6.3 - Fazer o Consumo do(s) Serviço(s) Solicitado(s)

################################################################################
# A forma de consumo do(s) serviço(s) solicitado(s) # e as respostas variam conforme
# o serviço solicitado. 
################################################################################

################################################################################
# ENDPOINT: /proderj-rjdigital/api/cms/servicos_busca/ 
################################################################################
curl -sX GET \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
"https://setd-2-homol-apicast-production.api-h.proderj.rj.gov.br/proderj-rjdigital/api/cms/servicos_busca/?page=1&search=CNH"

################################################################################
# ENDPOINT: /proderj-rjdigital/api/cms/orgaos_all/ 
################################################################################
curl -sX GET \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
"https://setd-2-homol-apicast-production.api-h.proderj.rj.gov.br/proderj-rjdigital/proderj-rjdigital/api/cms/orgaos_all/"

 

6.3.1  Exemplos de Resposta do Consumo do(s) Serviço(s) Solicitado(s)

6.3.1.1  ENDPOINT /proderj-rjdigital/api/cms/servicos_busca/

{
"count": 24,
"next": 2, "previous": null, "current": 1,
"query_param": "?page=", "page_size_query": "items_size", "page_size": 10,
"total_pages": 3, "results": [
{

"id": 86,
"slug": "agendar-adicao-de-categoria-na-cnh142", "agendavel": false,
"online": false,
"titulo": "Agendar Adição de Categoria na CNH",
"descricao": "<p>Permite voc&ecirc; solicitar a emiss&atilde;o de uma nova Carteira Nacional de Habilita&ccedil;&atilde;o, que tanto permitir&aacute; ao motociclista dirigir autom&oacute;vel (adicionando a categoria &quot;B&quot;), quanto permitir&aacute; ao motorista conduzir motocicletas (adicionando a categoria &quot;A&quot;).</p>",
"requisitos": "<p>Documenta&ccedil;&atilde;o:<br />

\r\nPara quem tem CNH COM FOTO, emitida no Estado do Rio de Janeiro<br />\r\n- Original do documento de identifica&ccedil;&atilde;o;<br />

\r\n- Original da CNH;<br />

\r\n- Original do Duda pago;<br />\r\n- Original e c&oacute;pia do comprovante de resid&ecirc;ncia ou fazer declara&ccedil;&atilde;o de resid&ecirc;ncia.<br />

\r\n<br />

\r\nObserva&ccedil;&otilde;es:<br />

\r\n- Se quiser alterar qualquer dado em seu cadastro (nome de solteiro para casado, nome do pai, nome da m&atilde;e, etc) ter&aacute; que apresentar original e c&oacute;pia do documento de identifica&ccedil;&atilde;o (carteira de identidade, CTPS, carteira emitida por organismos reguladores de profiss&atilde;o) j&aacute; atualizado com o novo dado.<br />

\r\n- Os clientes que possuem CNH com foto, mas que nela n&atilde;o conste o n&uacute;mero do CPF, ter&atilde;o que levar uma c&oacute;pia deste documento.<br />

\r\n

<br />

\r\nPara quem tem CNH SEM FOTO ou emitida em outro estado da federa&ccedil;&atilde;o<br />

\r\n- Original e c&oacute;pia do documento de identifica&ccedil;&atilde;o;<br />\r\n- Original e c&oacute;pia do CPF;<br />

\r\n-Original e c&oacute;pia do comprovante de resid&ecirc;ncia ou fazer declara&ccedil;&atilde;o de resid&ecirc;ncia;<br />\r\n- Original do Duda pago;<br />

\r\n- Original e c&oacute;pia da Carteira de Habilita&ccedil;&atilde;o.<br />

\r\n<br />\r\nObserva&ccedil;&otilde;es:<br />\r\n- Se o cliente quiser alterar qualquer dado em seu cadastro, ter&aacute; de apresentar original e  c&oacute;pia do documento com a nova informa&ccedil;&atilde;o.<br />\r\n- Os clientes que possuem CNH com foto, mas que nela n&atilde;o conste o n&uacute;mero do CPF, ter&atilde;o que levar uma c&oacute;pia deste documento.<br />

\r\n<br />

\r\nExames:<br />

\r\n- Exame m&eacute;dico;<br />\r\n- Exame psicol&oacute;gico (realizado nos 
casos em que o cliente opte pela op&ccedil;&atilde;o de exercer atividade remunerada);<br />\r\n- 
Prova de atualiza&ccedil;&atilde;o, quando necess&aacute;rio;<br />\r\n- Exame de dire&ccedil;&atilde;o.<br />\r\n<br
/>\r\nATEN&Ccedil;&Atilde;O: Desde 02 de mar&ccedil;o de 2016 &eacute; obrigat&oacute;ria a 
realiza&ccedil;&atilde;o do exame toxicol&oacute;gico de larga janela de detec&ccedil;&atilde;o 
para a realiza&ccedil;&atilde;o dos servi&ccedil;os de habilita&ccedil;&atilde;o, 
renova&ccedil;&atilde;o ou mudan&ccedil;a para as categorias C, D e E.<br />\r\n&nbsp;</p>",
"publico": "<p>O servi&ccedil;o est&aacute; dispon&iacute;vel para cidad&atilde;os 
habilitados.</p>",
"informacoes_extra": "<p>Observa&ccedil;&otilde;es:<br />\r\n- Se o cliente pagar o Duda em 
dinheiro, o servi&ccedil;o s&oacute; poder&aacute; ser agendado em 24 horas. Se for em cheque, somente seis dias depois. Esses s&atilde;o os prazos para que o banco informe ao Detran-RJ sobre os pagamentos.<br />\r\n<br />

\r\nCustos:<br />

\r\nDUDA: (cod.:203-8) R$ 173,03<br />\r\nCaso seja necess&aacute;rio fazer reexame (por reprova&ccedil;&atilde;o ou falta na prova): <br />

\r\nDUDA: (cod.:202-0) R$ 129,33<br />\r\nExame M&eacute;dico: R$ 95,00 - Reexame, caso seja necess&aacute;ria nova avalia&ccedil;&atilde;o, ap&oacute;s inaptid&atilde;o tempor&aacute;ria: R$ 47,50<br />

\r\n<br />

\r\nNos casos em que o cliente opte pela op&ccedil;&atilde;o de exercer atividade remunerada:<br />

\r\nExame Psicol&oacute;gico: R$ 135,00 - Reexame, caso seja necess&aacute;ria nova avalia&ccedil;&atilde;o ap&oacute;s inaptid&atilde;o tempor&aacute;ria: R$ 67,50<br />

\r\nATEN&Ccedil;&Atilde;O:Os exames m&eacute;dico e psicol&oacute;gico s&atilde;o cobrados pelas cl&iacute;nicas credenciadas pelo DETRAN/RJ.</p>",
"custo": "Veja em \"Informações Adicionais\"", "tempo": null,
"tempo_online": null, "tempo_total": 0, "tipo_tempo": "Anos", "setor_id": 82, "servicosUnidade": 
[], "total_avaliacao": 5.0, "orgao_sigla": "DETRAN",
"orgao_slug": "departamento-de-transito-do-estado-do-rio-de-janeiro10", "orgao_nome": "Departamento 
de Trânsito do Estado do Rio de Janeiro", "jornada": [
{

"id": 10,
"ordem": 5,
"titulo": "Realizar exames",
"conteudo": "Comparecer à clinica indicada para realizar os exames médicos solicitados.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},
{
"id": 48,
"ordem": 6,
"titulo": "Fazer matrícula na Autoescola",
"conteudo": "Fazer matrícula para ter aulas práticas num Centro de Formação de Condutores (CFC-Autoescola), que será responsável pelo agendamento do teste de direção no Detran-RJ.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},
{
"id": 78,
"ordem": 7,
"titulo": "Realizar a prova",
"conteudo": "Realizar a prova de acordo com as orientações do agendamento.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},
{
"id": 94,
"ordem": 8,
"titulo": "Retirar o documento",
"conteudo": "Após a aprovação em todos os exames e aguardado o prazo estabelecido, o motorista deve comparecer ao posto onde iniciou o serviço e retirar a CNH.Dessa forma sua solicitação foi atendida.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null
},
{
"id": 197,
"ordem": 1,
"titulo": "Acessar informações",
"conteudo": "Verificar as informações, taxas e a documentação necessária para a realização do serviço.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},
{
"id": 667,
"ordem": 2,
"titulo": "Efetuar pagamento das taxas", "conteudo": "<p>Emitir os boletos no site: <a href=\"https://www.ib7.bradesco.com.br/ibpfdetranrj/debitoVeiculoRJLoader.do\" 
target=\"_blank\">https://www.ib7.bradesco.com.br/ibpfdetranrj/debitoVeiculoRJLoad er.do</a> e 
efetuar o pagamento das taxas correspondentes ao servi&ccedil;o.</p>",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},
{
"id": 905,
"ordem": 3,
"titulo": "Preencher dados",
"conteudo": "Preencher os dados solicitados para iniciar o agendamento da solicitação.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

},

{
"id": 1086,
"ordem": 4,
"titulo": "Comparecer ao posto",
"conteudo": "Comparecer ao Posto do Detran selecionado no dia e hora agendados com a documentação exigida. Você vai receber o nome da clínica credenciada da região onde se encontra sua residência ou domicílio, com o respectivo endereço, telefone e horário de funcionamento, anotados no verso do formulário de exames. A clínica será indicada eletronicamente pelo sistema informatizado. Será escolhida a opção pela região onde o candidato exerça, 
comprovadamente, suas atividades profissionais, e para tanto deverá apresentar Carteira de Trabalho, contracheque, declaração do empregador ou equivalente.",
"tipo_atendimento": null, "conteudo_web": null, "conteudo_presencial": null

}
],
"acesso_externo": true,
"url_externo": 
"https://www.detran.rj.gov.br/todos-os-agendamentos/agendamento-hab/agend-adicao-de-categoria.html",

"integrado_form_flow": false, "publico_especifico": [
"Cidadão"
],
"categoria_slug": [ "veiculos-e-condutores"
],
"subcategoria_slug": [ "consultas-e-agendamentos176", "habilitacao180"
],
"solicitacao_simples": false, "descricao_solicitacao": "", "nivel": "Bronze", "categoria_items": [
{
"slug": "veiculos-e-condutores", "titulo": "Veículos e Condutores", "icone": "veiculo"
}
],

"subcategoria_items": [
{
"slug": "consultas-e-agendamentos176", "titulo": "Consultas e Agendamentos", "icone": "comunicacao"
},
{
"slug": "habilitacao180", "titulo": "Habilitação", "icone": "comunicacao"
}
],
"servicos_relacionados": [],

"created_at": "2022-05-01T08:48:11-03:00",
"servico_digital": false,

"poupatempo": false,

"cod_poupatempo": "",

"natureza_servico": null, 
"aplicativo": true,
"updated_at": "2025-02-18T15:53:24.089165-03:00"
},
]
}


6.3.1.2 - ENDPOINT /proderj-rjdigital/api/cms/orgaos_all/


[

{

"id": 2,

"slug": "centro-estadual-de-estatisticas-e-pesquisas-do-rio-de-janeiro2",

"nome": "Centro Estadual de Estatísticas e Pesquisas do Rio de Janeiro", "sigla": "CEPERJ"

},
...
]

 

 

 

Resolução SETD Nr. 143 de 14 de abril de 2026: Define as diretrizes para a interoperabilidade e o uso compartilhado de dados no âmbito do Poder Executivo Estadual (...)
Diário Oficial Nr. 069, de 17 abril de 2026, página 36


 

Arquivos bloco 1
Resolução SETD Nr. 143 de 14 de abril de 2026: Define as diretrizes para a interoperabilidade e o uso compartilhado de dados (1.43 MB)