Pular para o conteúdo principal

APIs

Autenticação​

Para a utilização das API’s descritas abaixo deve ser solicitado o Token de acesso à Betha Sistema, e com ele realizar a autorização no sistema Betha Protocolo (Cloud) nas devidas entidades.

Com posse do TOKEN e do USER-ACCESS gerado na autorização pelo sistema, será possível invocar as API’s.

Exemplo para Autenticação:

Authorization: Bearer 33a36133-f2ea-48b1-8f84-7a29e519ab98 User-Access: oQtyOjhjHH9pFeJlS3qBPJLLKS88dk8-dqKCL5Jh0=

API para adicionar documentos a processos e pareceres​

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/documento-criar

Essa API recebe dois parâmetros @RequestPart:

file - Arquivo a ser anexado

body - Json com as informações necessárias

   {
       "idProcesso": null, //informar quando o anexo é para o PROCESSO
       "idParecer": 687050, //informar quando o anexo é para PARECER (esse ID é retornado quando encerrado o processo)
       "documento": "Nome do documento",
        "usuario": "caciano",
        "data": "2024-03-03T23:59:59"
   }

API para encerrar o processo​

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/encerrar

    {
       "idProcesso": 621534, //Id do processo Protocolo Cloud
        "parecer": "AAAA 6000", //Texto do parecer/encerramento
        "data": "2024-06-03 09:02:00",
        "resultado": "DEFERIDO", // O resultado pode ser: DEFERIDO, INDEFERIDO, CONFIRMADO, ANULADO, CONHECIMENTO, PARCIAL, OUTROS, APROVADO, REJEITADO
        "usuario": "caciano"
    }

API para estornar o encerramento do processo​

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/estorno-encerramento

    {
        "id": 621534, //Id do processo Protocolo Cloud
        "data": "2024-06-03 09:03:00",
        "motivo": "Descrição do motivo do estorno",
        “usuario”: “caciano”
    }

API para consultar/vincular o usuário com o CPF/CNPJ​

Na primeira vez que o requerente/pessoa logar no aplicativo, é necessário que ele faça o vínculo do seu usuário com o seu CPF ou CNPJ.

GET: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/cidadao-usuarios /buscar?iUsuarios=fulano

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/cidadao-usuarios

body post:

  {
       "iUsuarios": "fulano",
        "inscricao": "01970344482"
  }

API para consulta dos assuntos​

Para realizar a abertura de processos, é necessário antes buscar a lista de Assuntos disponíveis para a abertura.

GET: GET: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/assuntos/buscar ?limit=20&offset=0&term=%25teste%25

API para criar um processo​

Nessa API poderá ser executado o POST para a criação de um processo no sistema Betha Protocolo (Cloud).

O CPF/CNPJ do requerente/pessoal já deve estar cadastrado no sistema Protocolo (Cloud).

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/processos body post:

 {
     "assunto": {
     "id": 20752
  },
     "requerente": {
     "cpfCnpj": "01970340983"
  },
     "sistema": "CLOUD",
     "motivoSolicitacao": "Teste Abertura Externa"
  }

API para criar comentários em um processo​

Nessa API poderá ser executado o POST para criar comentários em um processo.

POST: https://protocolo.suite.betha.cloud/parceiros/cidadao/v1/processos-externo/comentarios body post:

{
   "processo": 609754,
   "usuario": "caciano",
   "comentarioProcesso": "<p>Teste Comentario</p>",
   "tipoSigilo": "EXTERNO",
   "anexos": [
      {
         "id": 80781,
          "nome": "DownloadDN.pdf",
          "tipo": "application/pdf",
          "pasta": "/pessoas",
          "assinar": false,
          "chave": "9b43c201-b9d1-4112-8b44-6c3820922509"
         }   
      ]
   }

Obs. 1: O campo tipoSigilo pode ter os valores EXTERNO ou INTERNO

Obs. 2: O conteúdo da propriedade anexo, deve ser o retorno da API de anexo de documentos, descrita logo acima.