Skip to main content

​
Solicitação de Acesso às APIs sob gestão do Escritório de Dados

Fluxo simplificado de solicitação de acesso por e-mail Guia para equipes e órgãos que necessitam consumir APIs sob responsabilidade do Escritório de Dados da IplanRio. A solicitação inicial deve ser enviada ao Escritório de Dados, com a identificação do sistema e dos responsáveis pelo consumo. Solicitante: Responsável pelo sistema ou integração que utilizará a API.

​
Passo 1: Solicitação ao Escritório de Dados

Responsável: Equipe solicitante Envie um e-mail para ed.iplanrio@prefeitura.rio, com os responsáveis pelo sistema em cópia. Utilize o assunto “Solicitação de Acesso à API - [Sistema] - [API]” e informe:
  • Solicitante e equipe: nome, órgão ou instituição e e-mail institucional.
  • Nome do sistema consumidor: nome do sistema ou integração que acessará a API, acompanhado de uma breve descrição. Informação obrigatória.
  • Responsáveis: nome e e-mail do responsável técnico e do responsável de negócio, além do contato para avisos de mudanças.
  • Finalidade: justificativa e uso pretendido da API.
  • Escopo: API, endpoints e operações desejadas; se não souber os endpoints, descreva a funcionalidade necessária.
  • Ambientes: desenvolvimento, homologação e/ou produção, conforme a necessidade.
  • IP de origem para a whitelist: informe o(s) endereço(s) IP de saída do sistema que deverão ser autorizados para acessar a API, indicando o ambiente correspondente a cada IP. Informação obrigatória. Caso haja NAT ou proxy, informe o IP de saída apresentado à API; confirme esse endereço com a equipe de infraestrutura.
  • Consumo e criticidade: volume e frequência estimados e impacto de uma indisponibilidade. Informe quando a estimativa não estiver disponível.
  • Prazo de acesso: data desejada de início e término ou justificativa para uso contínuo.
Não inclua senhas, tokens ou chaves de acesso no e-mail.

​
Modelo de e-mail

Para: ed.iplanrio@prefeitura.rio Cc: [Responsáveis pelo sistema]

​
Passo 2: Análise e aprovação

Responsável: Escritório de Dados e responsáveis pela API O Escritório de Dados confere as informações e encaminha o pedido para análise técnica e, quando aplicável, aprovação do responsável de negócio ou controlador dos dados. Caso sejam necessárias informações adicionais, o solicitante será contatado na mesma conversa de e-mail.
A aprovação define os ambientes, endpoints, operações, IPs de origem e condições de uso autorizados, incluindo a validade quando aplicável. O envio da solicitação não autoriza o consumo imediato da API.

​
Passo 3: Liberação e validação do acesso

Responsável: Equipe técnica da API e equipe solicitante Após a aprovação, a equipe técnica inclui os IPs autorizados na whitelist e concede o acesso. O solicitante recebe as orientações de uso, o escopo liberado e a validade, quando aplicável. As credenciais serão disponibilizadas pela equipe técnica e enviadas ao solicitante. A equipe solicitante testa a integração a partir dos IPs e no ambiente autorizados e confirma o resultado na mesma conversa de e-mail. O Escritório de Dados registra a concessão no inventário de consumidores, vinculando o nome do sistema, seus responsáveis, os IPs liberados por ambiente e o acesso aprovado.

​
Passo 4: Acompanhamento e atualização

Responsável: Escritório de Dados, equipe técnica e responsável pelo sistema consumidor Mantenha os contatos atualizados e comunique as situações abaixo pelo mesmo canal, informando o sistema, a API e a referência da solicitação anterior.

​
Informações adicionais

Utilize o acesso somente para a finalidade e o escopo aprovados. Proteja as credenciais e comunique suspeitas de uso indevido ao Escritório de Dados. Suporte: ed.iplanrio@prefeitura.rio