Como usar

Arquivos

EndPoint responsável em receber os parâmetros da operação para disponibilizar arquivo zip, em base64, contendo os arquivos originais + conferência de assinatura + P7S

Legenda:

Tipo Operação:

1 = Contrato Qcertifica;

2 = CVM 531 / Duplicata Digital.

Campos Obrigatórios

Operações

Número da Remessa OU CNPJ Cedente + Data da Operação OU ID Externo;

Contratos

Número do Contrato OU dois ou mais parâmetros;

Nova requisição de Download

Nesta versão os arquivos não são gerados no ato da requisição, mas sim preparados por rotinas internas de forma assíncrona. Cabe ao usuário fazer uma única requisição para receber um GUID, e com este fazer requisições ao endpoint de download. Inicialmente o retorno será 202, notificando que a requisição é válida, porém, a geração do arquivo .zip não foi finalizada. Deve-se fazer novas requisições a mesma rota periodicamente (com alguns poucos minutos de intervalo), para acompanhar a requisição. Uma vez que o retorno seja 200, isso significa que o download poderá ser feito.

Requisição

Endpoint usado para requerir que o sistema prepare o arquivo ZIP com P7S e "Original + Conferência". Nesta versão é possível somente gerar a partir de Operações(CVM531), não podendo mais gerar a partir de Contratos. O corpo da requisição deverá conter uma das 3 possibilidades:

Data da Operação e CNPJ do Cedente

Número da Remessa

Identificador Externo

Exemplo para Download do Zip em C#

Abaixo um trecho de código onde demonstra o download do arquivo retornado pelo Endpoint de autorizações v1 e salvando localmente.

Exemplo para Download do Zip em C# - v2

Este código de exemplo serve apenas para os endpoints v2 desta API.

Exemplo de collection para Postman

AutorizaçõesRequest:Método: GET
URL: https://flipapi.qcertifica.com.br/v1/flip/autorizacoes
Query Params:

Token (obrigatório)

Body (vazio)

Headers (opcional)

Script Pré-Requisição (opcional)

Script Teste (opcional)
Response

{
    "token": "123456789",
    "tokenType": "bearer",
    "expiresIn": 15,
    "issued": "2024-03-12T11:34:11.445941Z",
    "expires": "2024-03-12T11:49:11.445941Z"
}

ArquivosRequest:Método: GET
URL: https://flipapi.qcertifica.com.br/v1/flip/arquivos
Query Params:

TipoOperacao (obrigatório)

DataOperacao

CnpjCedente

NumeroRemessa

DataImportacaoContrato

NumeroContrato

Assunto

CnpjDaParte

IdExterno

Body (vazio)
Headers:

Authorization: Bearer {{token}}
Script Pré-Requisição (opcional)
Script Teste (opcional)
Response

{
    "fileContents": "XXX",
    "contentType": "application/zip",
    "fileDownloadName": "arquivo.zip",
    "lastModified": null,
    "entityTag": null,
    "enableRangeProcessing": false
}

Você precisará definir a variável {{token}} no ambiente do Postman com o valor do token recebido no primeiro pedido. Isso garantirá que o cabeçalho Authorization Bearer seja preenchido corretamente com o token JWT.

Requisição#

Requisição