Skip to content

API -Processo de Assinatura

Montando o HEADER para poder fazer as requisições GET, POST, PATCH, PUT, DELETE.

Header Parameters: (Autenticação da Aplicação)

  • url: < url >
  • Authorization: Token < Access-Token >
  • Content-Type: 'application/json'

Token da Aplicação no Portal de Serviços

  • Menu lateral > Admin > Autenticação > Contas de aplicação > Pesquisar nome da aplicação

Processo de Assinatura

  • O usuário deverá escolher o tipo de documento a ser iniciado.
  • É obrigatório colocar uma identificação externa ou nome no processo de assinatura, que segue o padrão de começar com a abreviação do tipo de documento, caso já exista uma identificação externa igual não será possível prosseguir com o processo.
  • O campo prazo de conclusão é a quantidade de dias que o processo foi feito ao início de sua vigência.
  • Os campos Unidade/Escritório, Articulador e Gestor da Unidade, Fornecedor do Contrato e Contrato no RM, Vigência, Número Licitação e Sistemas Externos, são campos obrigatórios ou não para determinados tipo de documento.Estes campos só aparecem quando um destes dados é necessário, sendo obrigatório para aquele tipo de documento.
  • O campo resumo é obrigatório.
  • O campo tipo de Assinante possui uma lista de tipos de assinante , sendo estes gerenciáveis na administração em tipos de assinante e parametrizáveis em tipos de documentos, onde cada tipo de documento pode ter um ou mais tipos de assinante, dependendo do tipo serão necessários o preenchimento de outros campos, como, tipo de usuário, fornecedor e usuário

Autenticação com NodeJS:

Adicionar para todas as requisições.

var fetch = require('node-fetch');

fetch('<URL>', {
  method: '<METHOD>',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Token <Access-Token>'
  },
  body: <body>
});

Autenticação com cURL :

Adicionar para todas as requisições.

curl -v -X <METHOD> <URL> \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <Access-Token>' \
-d '{<body>}

Tipo de Documento

* Documentação da API
* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/
* Método HTTP: GET

{
  "id": 2,
  "nome": "Colaborador/Articulador",
  "ativo": true,
  "filtra_clientes": false,
  "filtra_advogados": false,
  "filtra_colaboradores": true,
  "filtra_fornecedores": false,
  "filtra_diretores": false,
  "imutavel": false,
  "filtros_vinculos_fornecedor": {
    "is_advogado": true,
    "is_contador": true,
    "representante_legal": true,
    "responsavel": true
  }
}

id (number): O ID do tipo de assinante.
nome (string): O nome do tipo de assinante.
ativo (boolean): Indica se o tipo de assinante está ativo.
filtra_clientes (boolean): Indica se o tipo de assinante filtra clientes.
filtra_advogados (boolean): Indica se o tipo de assinante filtra advogados.
filtra_colaboradores (boolean): Indica se o tipo de assinante filtra colaboradores.
filtra_fornecedores (boolean): Indica se o tipo de assinante filtra fornecedores.
filtra_diretores (boolean): Indica se o tipo de assinante filtra diretores.
imutavel (boolean): Indica se o tipo de assinante é imutável.
filtros_vinculos_fornecedor (object): Um objeto contendo informações sobre os filtros de vínculos com fornecedores.

const axios = require('axios');
axios.get('https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/')
  .then(response => {
    const tiposAssinante = response.data;
    console.log(tiposAssinante);
  })
  .catch(error => {
    console.error('Erro:', error);
  });

curl -X GET https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/

Unidade e Escritório

* Documentação da API
* Endpoint
* URL: https://hmgportalamei.ce.sebrae.com.br/api/unidade/escritorio_sebraes/
* Método HTTP: GET

{
  "_url_": "http://hmgportalamei.ce.sebrae.com.br/api/unidade/escritorio_sebraes/35/",
  "id": 35,
  "nome": "Unidade de Relacionamento - b",
  "endereco": "Rua X",
  "telefone_contato": "85999999999",
  "publicar": true,
  "ativo": true,
  "usuarios": [
    "http://hmgportalamei.ce.sebrae.br/api/UsuarioPortalAtendimento/77462123-286c-4f32-bef1-accc81bd4b96/",
    "http://hmgportalamei.ce.sebrae.com.br/api/UsuarioPortalAtendimento/00819f61-6f15-4c31-80f3-05de008071ef/",
    "http://hmgportalamei.ce.sebrae.com.br/api/UsuarioPortalAtendimento/00819f61-6f15-4c31-80f3-05de008071ef/"
  ],
  "unidades_associadas": []
}

_url_ (string): A URL do recurso da unidade de escritório.
id (number): O ID da unidade de escritório.
nome (string): O nome da unidade de escritório.
endereco (string): O endereço da unidade de escritório.
telefone_contato (string): O número de telefone de contato da unidade.
publicar (boolean): Indica se a unidade de escritório está publicada.
ativo (boolean): Indica se a unidade de escritório está ativa.
usuarios (array): Uma lista de URLs de usuários associados à unidade.
unidades_associadas (array): Uma lista de unidades associadas a esta unidade.


const axios = require('axios');
axios.get('https://hmgportalamei.ce.sebrae.com.br/api/unidade/escritorio_sebraes/')
  .then(response => {
    const unidadesEscritorio = response.data;
    console.log(unidadesEscritorio);
  })
.catch(error => {
    console.error('Erro:', error);
  });

curl -X GET https://hmgportalamei.ce.sebrae.com.br/api/unidade/escritorio_sebraes/

Tipo de Assinante

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/
* Método HTTP: GET

{
  "id": 2,
  "nome": "Colaborador/Articulador",
  "ativo": true,
  "filtra_clientes": false,
  "filtra_advogados": false,
  "filtra_colaboradores": true,
  "filtra_fornecedores": false,
  "filtra_diretores": false,
  "imutavel": false,
  "filtros_vinculos_fornecedor": {
    "is_advogado": true,
    "is_contador": true,
    "representante_legal": true,
    "responsavel": true
  }
}

id (number): O ID do tipo de assinante.
nome (string): O nome do tipo de assinante.
ativo (boolean): Indica se o tipo de assinante está ativo.
filtra_clientes (boolean): Indica se o tipo de assinante filtra clientes.
filtra_advogados (boolean): Indica se o tipo de assinante filtra advogados.
filtra_colaboradores (boolean): Indica se o tipo de assinante filtra colaboradores.
filtra_fornecedores (boolean): Indica se o tipo de assinante filtra fornecedores.
filtra_diretores (boolean): Indica se o tipo de assinante filtra diretores.
imutavel (boolean): Indica se o tipo de assinante é imutável.
filtros_vinculos_fornecedor (object): Um objeto contendo informações sobre os filtros de vínculos com fornecedores.


const axios = require('axios');
axios.get('https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/')
  .then(response => {
    const tiposAssinante = response.data;
    console.log(tiposAssinante);
  })
  .catch(error => {
    console.error('Erro:', error);
  });

curl -X GET https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/tipo-assinante/

Processo de Assinatura

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/
* Método HTTP: GET

{
  "id": "696b29b4-6850-4402-9fad-f2a6b12565a4",
  "tipo": 1,
  "verbose_tipo": "Teste 01",
  "chave": "TS010001",
  "tipo_processo": "sequencial",
  "identificacao_externa": "TS01QWERTY",
  "data_criacao": "2023-10-03T18:41:23.873057Z",
  "permitir_download": true,
  "chave_sistema_externo": [],
  "fornecedor_contrato": null,
  "numero_contrato": "",
  "numero_licitacao": "",
  "justificativa": null,
  "unidade": null,
  "articulador_unidade": null,
  "gestor_unidade": null,
  "prazo_conclusao": null,
  "inicio_validade": null,
  "termino_validade": null,
  "arquivo": "https://minio-dev.geomk.com.br/djn00a-media-dev/documento/2023/10/pdfFile_UmEDrsw_mc2Uwco.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ACCESSKEYDEV%2F20231011%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20231011T142051Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a84c1e9ad95d4b77b413864b06fa416d656cb0f9d3fd47eebecf1655186511db",
  "data_finalizado": null,
  "status": "pendente",
  "vinculos": [],
  "sigiloso": false,
  "verbose_status": "Pendente",
  "resumo": "qwerty",
  "empresas": [],
  "observacao": "",
  "assinante_atual": {
    "id": 1,
    "ordenador": 0,
    "usuario": "Erick Nicolas Thomas(773.834.462-83)",
    "datahora_assinatura": null,
    "datahora_enviadoemail": "2023-10-03T18:42:05.541874Z",
    "tipo_assinante": "Colaborador/Articulador",
    "verbose_tipo_assinante": "Colaborador/Articulador",
    "assinatura": "E-mail enviado: 03/10/2023 às 15:42",
    "numero_oab": "",
    "fornecedor": null,
    "email_principal": "teste@gmail.com",
    "celular_principal": null
  },
  "assinantes": [
    {
      "id": 1,
      "ordenador": 0,
      "usuario": "Erick Nicolas Thomas(773.834.462-83)",
      "datahora_assinatura": null,
      "datahora_enviadoemail": "2023-10-03T18:42:05.541874Z",
      "tipo_assinante": "Colaborador/Articulador",
      "verbose_tipo_assinante": "Colaborador/Articulador",
      "assinatura": "E-mail enviado: 03/10/2023 às 15:42",
      "numero_oab": "",
      "fornecedor": null,
      "email_principal": "teste@gmail.com",
      "celular_principal": null
    }
  ],
  "criador_do_documento": "773.834.462-83",
  "assinatura_sem_certificado": false,
  "projeto_acao_rm": [],
  "prazo_assinatura": "2023-10-04"
}

id (string): O ID do processo.
tipo (number): O tipo do processo.
verbose_tipo (string): A descrição detalhada do tipo do processo.
chave (string): A chave do processo.
tipo_processo (string): O tipo de processo.
identificacao_externa (string): A identificação externa do processo.
data_criacao (string): A data de criação do processo.
permitir_download (boolean): Indica se é permitido fazer download do processo.
arquivo (string): O URL do arquivo associado ao processo.
status (string): O status do processo.
sigiloso (boolean): Indica se o processo é sigiloso.
resumo (string): Um resumo do processo.
observacao (string): Observações relacionadas ao processo.
assinante_atual (object): Informações sobre o assinante atual do processo.
assinantes (array): Uma lista de assinantes do processo.


const axios = require('axios');
axios.get('https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/')
  .then(response => {
    const processos = response.data;
    console.log(processos);
  })
  .catch(error => {
    console.error('Erro:', error);
  });

curl -X GET https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/
* Método HTTP: POST

{
  "tipo": 9,
  "identificacao_externa": "AATE",
  "chave_sistema_externo": [],
  "fornecedor_contrato": "",
  "arquivo": {
    "name": "pdfFile.pdf",
    "Base64": "JVBERi0xLjMKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvU",
    "url": ""
  },
  "assinantes": [
    {
      "fornecedor": null,
      "ordenador": 0,
      "tipo_assinante": 2,
      "usuario": "00819f61-6f15-4c31-80f3-05de008071ef"
    }
  ],
  "chave_sistema_externo": [],
  "fornecedor_contrato": "",
  "gestor_unidade": null,
  "inicio_validade": null,
  "numero_contrato": "",
  "numero_licitacao": "",
  "observacao": "",
  "pdfFile": null,
  "permitir_download": true,
  "prazo_assinatura": null,
  "prazo_conclusao": null,
  "projeto_acao_rm": [],
  "resumo": "teste",
  "sigiloso": false,
  "termino_validade": null,
  "tipo_processo": "sequencial",
  "unidade": null,
  "vinculos": [
    "TS01QWERTY10"
  ]
}

tipo (number): O tipo do processo.
identificacao_externa (string): A identificação externa do processo.
chave_sistema_externo (array): Uma lista de chaves de sistemas externos.
fornecedor_contrato (string): O fornecedor de contrato.
arquivo (object): Informações sobre o arquivo associado ao processo.
assinantes (array): Uma lista de assinantes do processo.

const axios = require('axios');
const data = {
  // Inserir o corpo da solicitação aqui
};
axios.post('https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/', data)
  .then(response => {
    console.log('Solicitação POST bem-sucedida:', response.data);
  })
  .catch(error => {
    console.error('Erro na solicitação POST:', error);
  });


curl -X POST -H "Content-Type: application/json" -d '{
  "tipo": 9,
  "identificacao_externa": "AATE",
  "chave_sistema_externo": [],
  "fornecedor_contrato": "",
  "arquivo": {
    "name": "pdfFile.pdf",
    "Base64": "JVBERi0xLjMKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvU",
    "url": ""
  },
  "assinantes": [
    {
      "fornecedor": null,
      "ordenador": 0,
      "tipo_assinante": 2,
      "usuario": "00819f61-6f15-4c31-80f3-05de008071ef"
    }
  ],
  "chave_sistema_externo": [],
  "fornecedor_contrato": "",
  "gestor_unidade": null,
  "inicio_validade": null,
  "numero_contrato": "",
  "numero_licitacao": "",
  "observacao": "",
  "pdfFile": null,
  "permitir_download": true,
  "prazo_assinatura": null,
  "prazo_conclusao": null,
  "projeto_acao_rm": [],
  "resumo": "teste",
  "sigiloso": false,
  "termino_validade": null,
  "tipo_processo": "sequencial",
  "unidade": null,
  "vinculos": [
    "TS01QWERTY10"
  ]
}' https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/

Busca de Usuário

  • Endpoint: /fornecedor/usuario-assinatura-autocomplete/
  • Metodo: GET
  • Response: 
"results": [
  {
    "id": "f1eb02f4-5702-4666-a1ab-9dd132934e49",
    "text": "ADMIN BANCO SAS (745.736.790-06)"
  }
]

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/{id}/iniciar/
* Método HTTP: POST

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/{id}/suspender/
* Método HTTP: POST
* Body: 
{
  "justificativa": "Justificativa para suspender",
  "permitir_download": true
}

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/{id}/reativar/
* Método HTTP: POST

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/{id}/cancelar/
* Método HTTP: POST
{
  "justificativa": "Justificativa para suspender",
  "permitir_download": true
}

* Endpoint
* URL: https://portaldeassinaturahomologaamei.ce.sebrae.com.br/api/processo/{id}/copiar/
* Método HTTP: POST