Referência da API

Endpoint da API

O endpoint base da API é https://api.printrouter.magazord.com.br/api.

AS URLs relativas nessa documentação são relativas a essa base de API.

Autenticação

Todas as requisições à API devem ser autenticadas. Por isso, Antes de usar a API do Print Router, você precisará criar uma conta.

Para criar uma nova conta você deverá entrar em contato conosco onde estaremos fornecendo as chaves necessárias para você autenticar as sua requisições.

Uma chave de api é composta por um nome de usuário e uma chave utilizadas para identificar o seu aplicativo em todas as interações com o Print Router.

A API do Print Router utiliza o conceito de Basic Authentication, exigindo o preenchimento do header Authorization com a representação basic do nome do usuário combinado com a sua chave.

Content-Type

Todos os dados enviados ao Print Router por POST devem enviados usando o cabeçalho: Content-Type: application/json.

Qualquer resposta enviada pelo Print Router que venha a conter algum conteúdo utilizará a mesma representação de conteúdo.

Gerando uma impressão

Para disparar uma impressão você precisa realizar uma chamada ao endpoint /print.

Um exemplo da chamada a APi utilizando o utilitário curl se dá como o abaixo:

curl --location 'https://api.printrouter.magazord.com.br/api/print' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dXNlcm5hbWU6YXBpLWtleQ==' \
--data '{
  "printerId": "printer-01",
  "content": "...conteúdo a ser impresso com base no contentType definido",
  "title": "Imprimindo nota fiscal número 123 e série 456",
  "contentType": "pdf_base64",
  "paper": "A4",
}'

A integração espera uma série de campos que devem ser enviados representando um pedido de impressão:

Campo	Tipo	Obrigatório	Descrição
printerId	Texto	Sim	Chave da impressora que receberá a impressão. O valor deve ser obtido a partir da listagem de impressoras.
content	Texto	Sim	Conteúdo do documento a ser envido para a impressora sendo uma representação em base64 de um arquivo pdf ou de um arquivo texto nativo da impressora.
title	Texto	Sim	Título do documento a ser exibido na fila de impressão do sistema operacional.
contentType	Texto	Sim	Tipo do conteúdo encaminhado para impressão podendo ser pdf_base64 (para arquivos em pdf) ou raw_base64 (para texto nativo da impressora)
paper	Texto	Sim	Tipo do papel a ser utilizado como base de impressão podendo ser A4, ARGOR_GRANDE ou ARGOX_PEQUENA

Listando impressoras

O aplicativo desktop do Print Router, instalado no sistema operacional do cliente, desempenha um papel crucial:

Toda vez que o aplicativo é inicializado é realizado a captura das impressoras disponíveis para posterior consulta no processo de impressão.

É a partir desse registro que a API disponibiliza a lista de impressoras disponíveis pelo endpoint /printers.

Um exemplo da chamada a API utilizando o utilitário curl se dá como o abaixo:

curl --location 'https://api.printrouter.magazord.com.br/api/printers' \
--header 'Authorization: Basic dXNlcm5hbWU6YXBpLWtleQ=='

A listagem das impressoras disponíveis para o usuário será retornada no formato application/json:

{
  "status": "success",
  "data": {
    "items": [
      {
        "id": "hostname#DESKTOP-ZDPRTKHE#printer#Argox OS-214 plus series PPLA",
        "hostname": "DESKTOP-ZDPRTKHE",
        "name": "Argox OS-214 plus series PPLA",
        "conection_status": {
          "statusDate": "2026-04-02T16:37:44.776Z",
          "statusValue": "connected"
        }
      },
      {
        "id": "hostname#DESKTOP-ZDPRTKHE#printer#EPSON L380 Series",
        "hostname": "DESKTOP-ZDPRTKHE",
        "name": "EPSON L380 Series",
        "conection_status": {
          "statusDate": "2026-04-02T16:37:44.776Z",
          "statusValue": "connected"
        }
      }
    ]
  }
}

A integração espera uma série de campos que devem ser enviados representando um pedido de impressão:

Campo	Descrição
id	Chave da impressora. O seu valor deverá ser utilizado no campo printerId ao gerar uma nova impressão
hostname	Nome do computador onde a impressora está configurada.
name	Nome da impressora seguindo sua configuração no sistema operacional.
connection_status	Informações de conexão da impressora como estado de conexão e data hora da ultima conexão.