# QI Tech — CertifiQI › Primeiros Passos Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 6 página(s). Índice: - Ambientes (/documentation/certifiqi/ambientes) - Criação de Perfil de Acesso (/documentation/certifiqi/cadastro) - Estrutura (/documentation/certifiqi/estrutura) - Forma de Autenticação (/documentation/certifiqi/forma_de_autenticacao) - Início (/documentation/certifiqi/inicio) - Permissão do usuário (/documentation/certifiqi/permissoes) --- # Ambientes URL: /documentation/certifiqi/ambientes Possuímos o ambiente de produção e o de sandbox. ### URL para API e Plataforma - Sandbox: - plataforma: https://sandbox.certifiqi.com.br/ - api: [https://api.sandbox.certifiqi.com.br](https://api.sandbox.certifiqi.com.br/) - Produção: - plataforma: https://certifiqi.com.br/ - api [https://api.certifiqi.com.br](https://api.sandbox.certifiqi.com.br/) :::danger Aviso Importante! Não devem ser usados dados reais de pessoas físicas e/ou jurídicas nos ambientes de Sandbox da QI Tech. ::: --- # Criação de Perfil de Acesso URL: /documentation/certifiqi/cadastro 1. Enviar solicitação de criação de acesso para o e-mail certifiqi@qitech.com.br informando os seguintes dados: 1. CNPJ da empresa 2. Nome completo do usuário Master 3. CPF do usuário Master 4. E-mail do usuário Master 2. Após a criação do acesso pelo time da QI Tech, o usuário Master receberá um e-mail com um link para acesso a plataforma da Certifiqi para efetuar o cadastro. 3. Ao realizar o primeiro acesso à plataforma, o usuário Master pode convidar os demais usuários para que também tenham acesso à plataforma. --- # Estrutura URL: /documentation/certifiqi/estrutura A Certifiqi possui eventos de assinatura (batch_group) que engloba diferentes documentos e seus assinantes. Abaixo será apresentado algumas nomenclaturas importantes para o entendimento do funcionamento da plataforma. ### Related Party Representa uma pessoa física ou jurídica (empresa) associada à assinatura de documentos. Pode incluir um ou mais grupos de assinantes. ### Signer Group Grupo de assinantes que compõem uma parte relacionada. Caso qualquer um dos grupos configurados seja satisfeito (número mínimo de assinaturas ou valor representado), a parte relacionada será considerada como assinada. Permite flexibilidade na configuração de regras de assinatura para empresas. ### Signer Um assinante pertencente a um grupo. É possível definir se sua assinatura é obrigatória dentro do grupo para que a condição do grupo seja atendida. ### Document Documento que deverá ser assinado. ### Document Batch Conjunto de documentos de um determinado tipo que deve ser assinado por uma ou mais partes relacionadas. Um evento de assinatura pode conter múltiplos batches, representando diferentes categorias de documentos. ### Batch Group Evento de assinatura que agrupa diversos lotes (Document Batch) de documentos a serem assinados. ## Diagrama da estrutura ## Exemplo de Uso ### Diagrama O evento de assinatura contém dois elementos do tipo Document Batch: um para Duplicatas e outro para o Termo de Cessão. ### Document Batch – Duplicata - Contém dois documentos: Duplicata 1 e Duplicata 2. - Está associado a uma Related Party, que representa o Cedente. - Essa Related Party possui dois Signer Groups: - Signer Group 1: composto por dois assinantes (Signer 1 e Signer 2). - Signer Group 2: composto por um assinante (Signer 3). Para que a Related Party seja considerada como tendo assinado, basta que um dos Signer Groups seja satisfeito. Isso pode ocorrer de duas formas: - Opção 1: Signer 1 e Signer 2 realizam a assinatura, satisfazendo o Signer Group 1. - Opção 2: Apenas o Signer 3 assina, satisfazendo o Signer Group 2. Uma vez que a Related Party é satisfeita por qualquer uma dessas opções, o Document Batch de Duplicatas será considerado como assinado. ### Document Batch – Termo de Cessão - Contém um documento: Termo de cessão. - Possui duas Related Party: - Cedente - Administrador do fundo - Cada Related Party possui um grupo de assinante - A Related Party da consultoria possui um Signer Group com dois assinantes, assim é necessário que os assinantes assinem para concluir a parte relacionada da consultoria. - A Related Party do administrador do fundo possui um Signer Group com um assinante, assim é necessário que o assinante assine para concluir a parte relacionada da administradora do fundo. Uma vez que as Related Partys são satisfeitas, o Document Batch de Termo de Cessão será considerado como assinado. --- # Forma de Autenticação URL: /documentation/certifiqi/forma_de_autenticacao Para realizar uma requisição em nossa plataforma, é necessário incluir a chave de API no header da solicitação, utilizando o campo x-api-token , conforme o exemplo abaixo: Header ```json {"x-api-token": "\"} ``` Essa chave é exclusiva para cada cliente e pode ser solicitada por e-mail, enviando sua solicitação para certifiqi@qitech.com.br. --- # Início URL: /documentation/certifiqi/inicio A plataforma Certifiqi tem como objetivo efetuar assinaturas através de certificados dentro do padrão ICP-Brasil. Além disso, as assinaturas são feitas em poucos segundos para um alto volume de documentos. Para mais informações acesse: https://qitech.com.br # Métodos de Assinatura ### Cades - Forma de assinatura digital em que o arquivo da assinatura fica em um arquivo separado. - Arquivo no formato p7s. ### Pades - Forma de assinatura digital em que a assinatura fica contida dentro do próprio PDF. - Arquivo no formato PDF. --- # Permissão do usuário URL: /documentation/certifiqi/permissoes Os usuários na plataforma são divididos em três categorias de acesso, sendo master, assinante e observador. ### Master: - Consegue editar e criar eventos. - Visualiza todos os documentos. - Pode alterar as permissões dos usuários. ### Assinante: - Consegue assinar documentos na plataforma. - Visualiza os documentos que estiver como assinante. ### Observador - Consegue visualizar os documentos na plataforma.