Equipa e administração
Endpoints de API
Deixe programas, scripts e automações enviar documentos para um URL secreto e imprimi-los.
Um endpoint de API é um URL secreto para o qual os programas enviam documentos, por exemplo faturas de um ERP, etiquetas de uma loja online ou relatórios de um script. Cada documento torna-se um trabalho em nome da pessoa que criou o endpoint e vai para o seu destino. O próprio URL é a chave de acesso, por isso não é necessário um token de API. A referência da API descreve cada opção.
Pré-requisitos
- O canal de entrada REST API tem de estar ativo em Definições → Canais de entrada. Nas organizações novas está ativo; nas mais antigas, um administrador pode ter de o ativar.
- Cada membro pode criar endpoints de API. Os utilizadores veem os seus, os administradores todos os da organização.
- Incluído em todos os planos.
Configuração inicial
- Vá a Origens → Endpoints de API e selecione Novo endpoint de API.
- Introduza um Nome que diga para que serve o endpoint, por exemplo “Faturas do ERP”.
- Escolha a Rota dos documentos cujo pedido não indica nenhuma: um destino, grupo ou fluxo de trabalho, Rota predefinida (a do proprietário do endpoint) ou Sem rota – manter no Sealed Print.
- Selecione Criar e copie o URL do endpoint para o seu programa.
Envie o documento como corpo do pedido com o Content-Type adequado:
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
-H "Content-Type: application/pdf" \
--data-binary @invoice.pdf
Ou como formulário com o campo file; as opções vão como campos do formulário:
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
-F "file=@invoice.pdf" \
-F "name=Invoice" \
-F "copies=2"
targets envia um pedido para outro lado por identificador: os identificadores de destinos, grupos ou de um fluxo
de trabalho, separados por vírgulas, por exemplo targets=office,warehouse (um fluxo de trabalho vem primeiro).
destinationId, destinationIds, groupId ou workflowId fazem o mesmo por ID, e noTarget=true (ou
targets=hold) mantém o documento no Sealed Print. Substituem a rota do endpoint num pedido; as opções de impressão
como copies ou sides vão como parâmetros de consulta ou campos do formulário. A resposta é o trabalho (HTTP 201).
No dia a dia
- Última utilização no endpoint mostra se um programa ainda envia documentos.
- Editar altera o nome e a rota; o URL mantém-se.
- Gerar novo URL substitui o URL; o antigo deixa de funcionar de imediato. Eliminar termina o endpoint de vez.
- Para acompanhar o estado de um trabalho a partir do seu programa, use um token de API.
Resolução de problemas
- HTTP 403: o canal de entrada REST API está desativado, ou a pessoa que criou o endpoint saiu da organização. Crie um novo endpoint com outro membro.
- HTTP 404: o URL está errado ou foi substituído por um novo. Com o código
unknown_target, um identificador emtargetsnão existe ou pertence a um destino para o qual o proprietário do endpoint não pode imprimir. - HTTP 413 ou 415: o ficheiro é maior do que o plano permite, ou não é um PDF, JPEG ou PNG.
- O URL foi copiado para onde não devia: selecione Gerar novo URL de imediato.
Próximos passos
- Referência da API: cada endpoint, com a descrição OpenAPI.
- Tokens de API
- Canais de entrada e de saída
- Imprimir documentos do Stripe: faturas, notas de crédito e orçamentos do Stripe através de um endpoint de API.