Referência da API

Solicitar impressão

Envia uma solicitação de impressão para um SmartPOS específico. Este fluxo não altera o estado financeiro da venda.

POST

/v1/print-jobs

terminalcURL

1curl -X POST "https://api.connecttef.com.br/v1/print-jobs" \2  -H "x-api-key: <sua_api_key>" \3  -H "Content-Type: application/json" \4  -d '{5    "referencia": "9f1c2d3e-4b5a-4678-9abc-0d1e2f3a4b5c",6    "documentoCliente": "12345678000195",7    "smartposId": "POS001",8    "conteudo": {9      "tipo": "base64",10      "base64": "Q09NUFJPVkFOVEUgQ09OTkVDVFRFRg=="11    }12  }'

Headers

Campo	Tipo	Descrição
x-api-key	string	Chave de autenticação da integração, gerada no portal do parceiro.obrigatório
Content-Type	header	Use application/json em chamadas com body.obrigatório

Campos do body

Campo	Tipo	Descrição
referencia	string	Identificador único da impressão. Use um UUID começando no primeiro caractere e sem nada antes dele.obrigatório
documentoCliente	string	CPF ou CNPJ do cliente ConnectTEF vinculado ao SmartPOS.obrigatório
smartposId	string	SmartPOS que deve receber a solicitação de impressão.obrigatório
conteudo.tipo	string	Tipo do conteúdo enviado para impressão. Use base64 neste contrato.obrigatório
conteudo.base64	string	Conteúdo de impressão codificado em Base64.obrigatório

Resposta inicial

202 Accepted

Resposta inicialJSON

1{2  "referencia": "9f1c2d3e-4b5a-4678-9abc-0d1e2f3a4b5c",3  "status": "processando",4  "mensagem": "Impressao enviada ao SmartPOS.",5  "smartposId": "POS001",6  "targets": [7    {8      "smartposId": "POS001",9      "status": "enviado"10    }11  ]12}

Campos da resposta

Campo	Tipo	Descrição
referencia	string	Mesma referência enviada na requisição. Use para consultar, conciliar e deduplicar a operação.obrigatório
status	string	Estado inicial da operação. Não representa aprovação, recusa ou conclusão final.obrigatório
mensagem	string	Mensagem resumida sobre o aceite, envio ou fila inicial da operação.obrigatório
smartposId	string	SmartPOS direcionado pela operação, quando a rota retorna esse campo no nível principal.
targets	array	SmartPOS que receberam ou deveriam receber a solicitação inicial.obrigatório
targets[].smartposId	string	Identificador público do SmartPOS de destino.obrigatório
targets[].status	string	Resultado inicial de publicação para aquele SmartPOS.obrigatório

erro.jsonJSON

1{2  "erro": {3    "codigo": "API_KEY_INVALIDA",4    "mensagem": "API key invalida ou inativa.",5    "acao": "Confira se a chave foi copiada do portal do parceiro e se está ativa."6  }7}

HTTP	Código	Quando acontece	Como corrigir
400	`CAMPO_OBRIGATORIO`	Algum campo obrigatório da impressão está ausente ou vazio.	Revise referencia, documentoCliente, smartposId, conteudo.tipo e conteudo.base64.
400	`CAMPO_INVALIDO`	O conteúdo não está em Base64 válido ou algum campo excede o tamanho aceito.	Codifique o conteúdo corretamente e mantenha apenas o que precisa ser impresso.
401	`API_KEY_INVALIDA`	A chave não existe, foi rotacionada ou está inativa.	Use a chave ativa gerada no portal do parceiro.
403	`CLIENTE_NAO_AUTORIZADO`	A API key não autoriza operação para o cliente informado.	Confira se o cliente pertence ao parceiro da chave utilizada.
404	`SMARTPOS_NAO_ENCONTRADO`	smartposId não pertence ao cliente informado ou não está vinculado.	Use GET /v1/customers/{documentoCliente}/smartpos e selecione um smartposId válido.
409	`REFERENCIA_DUPLICADA`	A referência da impressão já foi usada em uma tentativa operacional anterior.	Se é uma nova tentativa de impressão, gere uma nova referência.
500	`ERRO_INTERNO`	A API encontrou uma falha inesperada ao processar a solicitação.	Registre status, referência e corpo da resposta antes de acionar o suporte.

Atenção

Impressão concluída ou falha de impressão são resultados operacionais. Não use esse evento para aprovar, recusar ou estornar venda.

Próximo passo

Confirmar a impressãoUse os eventos finais para confirmar se a impressão foi concluída ou falhou.