Documentação - API Provedora de Serviços

A API do provedor de serviços deve disponibilizar os endpoints abaixo especificados e seguir o padrão de resposta conforme exemplos.

Serviços Disponíveis

GET https://api_provedor/api/servicos

Retorna todos os serviços ativos no provedor. Caso seja definido o path parameter id_serviço retorna somente o serviço referente ao id.

Path Parameters

Name

Type

Description

id_servico

integer

Identificador do serviço no portal Gov.BR

{
  "resposta": [
    {
      "icone": "fa fa-question-circle",
      "id_servico_portal_govbr": 10056,
      "titulo": "Protocolar documentos junto ao IFRN",
      "descricao": "Possibilita aos cidadãos (portador ou interessado), aos órgãos e às entidades públicas e privadas protocolar documentos e processos pela Internet, de forma eletrônica, ao Instituto Federal de Educação, Ciência e Tecnologia do Rio Grande do Norte, sem a necessidade de se deslocarem fisicamente até os Campi ou Reitoria do IFRN e, ainda, evitar gastos com o envio de correspondência postal."
    }
  ],
  "mensagem": null,
  "has_error": false
}

GET https://api_provedor/api/servicos/{id_servico}/

Retorna somente o serviço referente ao id do path parameter id_servico

Path Parameters

Name

Type

Description

string

{
  "resposta": [
    {
      "icone": "fa fa-question-circle",
      "id_servico_portal_govbr": 10056,
      "titulo": "Protocolar documentos junto ao IFRN",
      "descricao": "Possibilita aos cidadãos (portador ou interessado), aos órgãos e às entidades públicas e privadas protocolar documentos e processos pela Internet, de forma eletrônica, ao Instituto Federal de Educação, Ciência e Tecnologia do Rio Grande do Norte, sem a necessidade de se deslocarem fisicamente até os Campi ou Reitoria do IFRN e, ainda, evitar gastos com o envio de correspondência postal."
    }
  ],
  "mensagem": null,
  "has_error": false
}

Serviços Disponíveis por CPF

GET https://api_provedor/api/servicos/cpf/{cpf}/

Retorna os serviços disponíveis para um determinado cidadão utilizando o path parameter CPF

Path Parameters

Name

Type

Description

cpf

string

CPF do cidadão

{
  "resposta": [
    {
      "icone": "fa fa-question-circle",
      "id_servico_portal_govbr": 10056,
      "titulo": "Protocolar documentos junto ao IFRN",
      "descricao": "Possibilita aos cidadãos (portador ou interessado), aos órgãos e às entidades públicas e privadas protocolar documentos e processos pela Internet, de forma eletrônica, ao Instituto Federal de Educação, Ciência e Tecnologia do Rio Grande do Norte, sem a necessidade de se deslocarem fisicamente até os Campi ou Reitoria do IFRN e, ainda, evitar gastos com o envio de correspondência postal."
    }
  ],
  "mensagem": null,
  "has_error": false
}

Consultar Disponibilidade de Serviços por CPF

GET http://api_provedor/api/servicos/cpf/{cpf}/avaliacao_disponibilidade

Retorna os serviços disponíveis para um determinado cidadão e detalha a disponibilidade do serviço, estando disponível quando is_ok = true e indisponível para is_ok = false, também são detalhados os critérios de sucesso e de erro utilizados na avaliação da disponibilidade

Path Parameters

Name

Type

Description

cpf

string

CPF do Cidadão

{
  "resposta": [
    {
      "servico": {
        "icone": "fa fa-question-circle",
        "id_servico_portal_govbr": 5804,
        "titulo": "Participar de processo seletivo para curso de Educação Profissional Técnica (Educação de Jovens e Adultos, Integrado e Subsequente) - IFRN",
        "descricao": "Se você deseja fazer um curso de Educação Profissional, de nível técnico, nas formas de Educação de Jovens e Adultos, Integrado ou Subsequente no Instituto Federal de Educação, Ciência e Tecnologia do Rio Grande do Norte, você precisa concorrer a uma vaga por meio deste serviço.\n\n"
      },
      "cpf": "682.564.070-42",
      "criterios_sucesso": "[]",
      "criterios_erro": "['Serviço inativo.']",
      "is_ok": false
    },
    {
      "servico": {
        "icone": "fa fa-question-circle",
        "id_servico_portal_govbr": 5950,
        "titulo": "Receber bolsa de Extensão - IFRN",
        "descricao": "Alunos dos cursos técnicos, graduação e pós-graduação que realizam atividades de extensão podem concorrer a auxílio financeiro em função destas atividades, através deste serviço em processo de seleção para o recebimento de bolsa de Extensão."
      },
      "cpf": "682.564.070-42",
      "criterios_sucesso": "[]",
      "criterios_erro": "['Serviço inativo.']",
      "is_ok": false
    },
    {
      "servico": {
        "icone": "fa fa-question-circle",
        "id_servico_portal_govbr": 6024,
        "titulo": "Obter 2ª via de diploma - IFRN",
        "descricao": "Se você já emitiu o seu diploma no Instituto Federal de Educação, Ciência e Tecnologia do Rio Grande do Norte, pode obter a 2º via do diploma através deste serviço."
      },
      "cpf": "682.564.070-42",
      "criterios_sucesso": "['Serviço ativo.', 'Não há solicitações em aberto.']",
      "criterios_erro": "[\"O aluno com o CPF '682.564.070-42' nunca emitiu um diploma.\"]",
      "is_ok": false
    },
    {
      "servico": {
        "icone": "fa fa-question-circle",
        "id_servico_portal_govbr": 6125,
        "titulo": "Receber bolsa de Pesquisa - IFRN",
        "descricao": "Alunos de graduação e pós-graduação que participam de projetos de pesquisa na Universidade podem concorrer a auxílio financeiro em função destas atividades, através deste serviço."
      },
      "cpf": "682.564.070-42",
      "criterios_sucesso": "[]",
      "criterios_erro": "['Serviço inativo.']",
      "is_ok": false
    }
  ],
  "mensagem": null,
  "has_error": false
}

Receber Solicitação

GET http://api_provedor/api/servicos/{{ id_servico }}/cpf/{{ cpf }}/receber_solicitacao/

Path Parameters

Name

Type

Description

cpf

string

CPF do Cidadão

{
  "resposta": {
    "etapa_atual": 1,
    "total_etapas": 2,
    "nome": "Etapa 1",
    "formulario": [
      {
        "type": "string",
        "label": "Assunto",
        "name": "assunto",
        "value": null,
        "required": true,
        "max_length": 100,
        "min_length": 0,
        "balcaodigital_user_info": null,
        "widget": "textinput",
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      },
      {
        "type": "string",
        "label": "Descri\u00e7\u00e3o",
        "name": "descricao",
        "value": null,
        "required": true,
        "max_length": 510,
        "min_length": 0,
        "balcaodigital_user_info": null,
        "widget": "textarea",
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      },
      {
        "type": "choices",
        "label": "Campus",
        "name": "campus",
        "value": null,
        "required": true,
        "choices_resource_id": "IlByb3RvY29sYXJEb2N1bWVudG9TZXJ2aWNlUHJvdmlkZXIuY2hvaWNlc191bmlkYWRlX29yZ2FuaXphY2lvbmFsIg:1k0U29:UUAX1q3SvCTELQxnhXGPJ4Cjo-Y",
        "filters": "null",
        "avaliacao_status": null,
        "avaliacao_status_msg": null,
        "display_value": null,
        "choices": {
          "8": "CAMPUS APODI",
          "7": "CAMPUS CAIC\u00d3",
          "13": "CAMPUS NATAL - CIDADE ALTA",
          "41": "CAMPUS CANGUARETAMA",
          "45": "CAMPUS CEAR\u00c1-MIRIM",
          "3": "CAMPUS CURRAIS NOVOS",
          "1": "CAMPUS NATAL - CENTRAL",
          "6": "CAMPUS IPANGUA\u00c7U",
          "9": "CAMPUS JO\u00c3O C\u00c2MARA",
          "55": "CAMPUS AVAN\u00c7ADO JUCURUTU",
          "47": "CAMPUS AVAN\u00c7ADO LAJES",
          "10": "CAMPUS MACAU",
          "4": "CAMPUS MOSSOR\u00d3",
          "16": "CAMPUS NOVA CRUZ",
          "48": "CAMPUS AVAN\u00c7ADO PARELHAS",
          "15": "CAMPUS PARNAMIRIM",
          "11": "CAMPUS PAU DOS FERROS",
          "12": "CAMPUS SANTA CRUZ",
          "17": "CAMPUS S\u00c3O GON\u00c7ALO DO AMARANTE",
          "43": "CAMPUS S\u00c3O PAULO DO POTENGI",
          "14": "CAMPUS AVAN\u00c7ADO NATAL-ZONA LESTE",
          "2": "CAMPUS NATAL - ZONA NORTE",
          "18": "REITORIA"
        }
      },
      {
        "type": "string",
        "label": "Descri\u00e7\u00e3o",
        "name": "anexo_1_descricao",
        "value": null,
        "required": false,
        "max_length": 100,
        "min_length": 0,
        "balcaodigital_user_info": null,
        "widget": "textinput",
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      },
      {
        "type": "file",
        "label": "Anexo",
        "name": "anexo_1_file",
        "value": null,
        "required": false,
        "label_to_file": "Anexo1",
        "limit_size_in_bytes": 2097152,
        "allowed_extensions": [
          "pdf"
        ],
        "value_hash_sha512_link_id": null,
        "value_hash_sha512": null,
        "value_content_type": null,
        "value_original_name": null,
        "value_size_in_bytes": null,
        "value_md5_hash": null,
        "value_charset": null,
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      },
      {
        "type": "string",
        "label": "Descri\u00e7\u00e3o",
        "name": "anexo_2_descricao",
        "value": null,
        "required": false,
        "max_length": 100,
        "min_length": 0,
        "balcaodigital_user_info": null,
        "widget": "textinput",
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      },
      {
        "type": "file",
        "label": "Anexo",
        "name": "anexo_2_file",
        "value": null,
        "required": false,
        "label_to_file": "Anexo2",
        "limit_size_in_bytes": 2097152,
        "allowed_extensions": [
          "pdf"
        ],
        "value_hash_sha512_link_id": null,
        "value_hash_sha512": null,
        "value_content_type": null,
        "value_original_name": null,
        "value_size_in_bytes": null,
        "value_md5_hash": null,
        "value_charset": null,
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      }
    ],
    "fieldsets": [
      {
        "name": "Dados do Requerimento",
        "fields": [
          "assunto",
          "descricao",
          "campus"
        ]
      },
      {
        "name": "Anexo 1",
        "fields": [
          "anexo_1_descricao",
          "anexo_1_file"
        ]
      },
      {
        "name": "Anexo 2",
        "fields": [
          "anexo_2_descricao",
          "anexo_2_file"
        ]
      }
    ]
  },
  "mensagem": null,
  "has_error": false
}

Receber Solicitação - Envio de Dados da Etapa

POST http://api_provedor/api/servicos/{{ id_servico }}/cpf/{{ cpf }}/receber_solicitacao/

Path Parameters

Name

Type

Description

cpf

string

CPF do cidadãos

Request Body

Name

Type

Description

json_data

object

JSON com dados submetidos pelo cidadão

{
  "resposta": {
    "situacao": "EM_ANALISE",
    "mensagem": "Dados enviados com sucesso. A sua solicitação está aguardando análise."
  },
  "mensagem": null,
  "has_error": false
}

{
  "resposta": {
    "etapa_atual": 2,
    "total_etapas": 2,
    "nome": "Etapa 2",
    "formulario": [
            {
        "type": "boolean",
        "label": "Confirmo",
        "name": "confirmacao",
        "value": null,
        "required": true,
        "html": "<p>Confirmo que os dados informados estão corretos.</p>",
        "avaliacao_status": null,
        "avaliacao_status_msg": null
      } 
    ],
    "fieldsets": [
      {
        "name": "Confirmação",
        "fields": [
          "confirmacao"
        ]
      }
    ]
  },
  "mensagem": null,
  "has_error": false
}

Autocompletar

POST http://api_provedor/api/servicos/autocompletar/

Path Parameters

Name

Type

Description

string

{
  "results": [
    {
      "id": 2300150,
      "text": "Acarape-CE"
    },
    {
      "id": 2300200,
      "text": "Acarau-CE"
    },
    {
      "id": 2300507,
      "text": "Alcantaras-CE"
    }
  ],
  "pagination": {
    "more": true
  }
}

Consultar Acompanhamentos por CPF

GET http://api_provedor/api/servicos/cpf/{cpf}/acompanhamentos/

Path Parameters

Name

Type

Description

cpf

string

CPF

{
  "resposta": [
    {
      "servico": 10056,
      "protocolo": 5966,
      "etapa": "Em An\u00e1lise",
      "dataEtapa": "28/07/2020",
      "situacaoEtapa": "Dados enviados com sucesso. A ",
      "dataSituacaoEtapa": "28/07/2020 - 17:15:40",
      "orgao": 36761,
      "nome_servico": "Protocolar documentos junto ao IFRN",
      "url_avaliacao": null
    }
  ],
  "mensagem": null,
  "has_error": false
}

Last updated 4 years ago

hashtagServiços Disponíveis

hashtagPath Parameters

hashtagPath Parameters

hashtagServiços Disponíveis por CPF

hashtagPath Parameters

hashtagConsultar Disponibilidade de Serviços por CPF

hashtagPath Parameters

hashtagReceber Solicitação

hashtagPath Parameters

hashtagReceber Solicitação - Envio de Dados da Etapa

hashtagPath Parameters

hashtagRequest Body

hashtagAutocompletar

hashtagPath Parameters

hashtagConsultar Acompanhamentos por CPF

hashtagPath Parameters

Serviços Disponíveis

Path Parameters

Path Parameters

Serviços Disponíveis por CPF

Path Parameters

Consultar Disponibilidade de Serviços por CPF

Path Parameters

Receber Solicitação

Path Parameters

Receber Solicitação - Envio de Dados da Etapa

Path Parameters

Request Body

Autocompletar

Path Parameters

Consultar Acompanhamentos por CPF

Path Parameters