{"openapi":"3.1.0","info":{"title":"Printmelo API","version":"1.0.0","description":"Print vanuit je eigen software naar printers op locatie.\n\nAuthenticatie gaat met een API-key: als `Authorization: Bearer <key>`, of als gebruikersnaam bij Basic-auth met een leeg wachtwoord. Een key maak je aan in het dashboard onder API-keys.\n\nEen key heeft rechten: `read` (bekijken), `print` (printjobs versturen, opnieuw printen en annuleren) en `manage` (inrichten en verwijderen). Bij elk endpoint staat welk recht het vraagt. Mist de key dat recht, dan volgt een 403 met `code: forbidden`. Een key kan ook een dagbudget voor printjobs hebben: is dat op, dan volgt een 429 met `code: key_budget`. Wat een key mag, staat in `GET /whoami`.\n\nElk antwoord met gegevens heeft de vorm `{\"data\": ...}`. Een fout heeft altijd een `message` en een vaste `code`.\n\nTijden zijn ISO 8601 met tijdzone. Ids zijn gehele getallen."},"servers":[{"url":"https://api.printmelo.com/api/v1","description":"Productie"}],"security":[{"bearer":[]},{"basic":[]}],"tags":[{"name":"Account","description":"Je account en je verbruik."},{"name":"Computers","description":"Computers waarop de client draait."},{"name":"Printers","description":"Printers die een computer heeft gemeld."},{"name":"Printjobs","description":"Documenten versturen en volgen."},{"name":"Printergroepen","description":"Print naar de eerste printer die beschikbaar is."},{"name":"Webhooks","description":"Laat je software direct weten wat er gebeurt."},{"name":"Sub-accounts","description":"Voor integrators: beheer accounts van je eigen klanten. Stuur de header `X-Child-Account-Id` of `X-Child-Account-Reference` mee om namens een sub-account te werken. Het verbruik telt mee in jouw abonnement."}],"paths":{"/whoami":{"get":{"tags":["Account"],"operationId":"whoami","summary":"Bekijk je account en verbruik","responses":{"200":{"description":"Het account van deze API-key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/computers":{"get":{"tags":["Computers"],"operationId":"listComputers","summary":"Bekijk alle computers","responses":{"200":{"description":"Alle computers van het account.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Computer"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/computers/{computer}":{"parameters":[{"name":"computer","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de computer. Het id of de uuid."}],"get":{"tags":["Computers"],"operationId":"getComputer","summary":"Bekijk één computer","responses":{"200":{"description":"De computer.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Computer"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."},"delete":{"tags":["Computers"],"operationId":"deleteComputer","summary":"Ontkoppel een computer","description":"Trekt het token van de client in en verwijdert de computer met zijn printers en printjobs.\n\nVraagt het recht `manage`.","responses":{"204":{"description":"De computer is ontkoppeld."},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage"}},"/computers/{computer}/printers":{"parameters":[{"name":"computer","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de computer. Het id of de uuid."}],"get":{"tags":["Printers"],"operationId":"listComputerPrinters","summary":"Bekijk de printers van een computer","responses":{"200":{"description":"De printers van deze computer.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Printer"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/printers":{"get":{"tags":["Printers"],"operationId":"listPrinters","summary":"Bekijk alle printers","responses":{"200":{"description":"Alle printers van het account.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Printer"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/printers/{printer}":{"parameters":[{"name":"printer","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printer. Het id of de uuid."}],"get":{"tags":["Printers"],"operationId":"getPrinter","summary":"Bekijk één printer","responses":{"200":{"description":"De printer.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Printer"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/practice-printer":{"post":{"tags":["Printers"],"operationId":"getPracticePrinter","summary":"Vraag de oefenprinter op","description":"De oefenprinter bestaat alleen bij Printmelo. Een printjob ernaartoe doorloopt alle toestanden en webhooks, maar er wordt niets geprint. Zo test je een koppeling zonder papier en zonder computer op locatie.\n\nEen oefenjob telt niet mee in je pakket en niet in het dagbudget van de key. In het antwoord staat `practice: true`. Bestaat de oefenprinter nog niet, dan maakt dit verzoek hem aan.\n\nVraagt het recht `print`.","responses":{"200":{"description":"De oefenprinter.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Printer"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"print"}},"/printers/{printer}/printjobs":{"parameters":[{"name":"printer","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printer. Het id of de uuid."}],"get":{"tags":["Printjobs"],"operationId":"listPrinterPrintJobs","summary":"Bekijk de printjobs van een printer","parameters":[{"$ref":"#/components/parameters/state"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"De printjobs van deze printer, nieuwste eerst.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintJobPage"}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."}},"/printjobs":{"get":{"tags":["Printjobs"],"operationId":"listPrintJobs","summary":"Bekijk printjobs","description":"Nieuwste eerst. Printjobs blijven 60 dagen bewaard.\n\nVraagt het recht `read`.","parameters":[{"name":"printer_id","in":"query","schema":{"type":"integer"},"description":"Alleen printjobs van deze printer."},{"$ref":"#/components/parameters/state"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Een pagina printjobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintJobPage"}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"read"},"post":{"tags":["Printjobs"],"operationId":"createPrintJob","summary":"Verstuur een printjob","description":"De client print het document zodra hij het seintje krijgt. Is de computer niet verbonden, dan print het zodra hij terug is, tot de job verloopt.\n\nStuur de header `Idempotency-Key` mee om dubbele printjobs te voorkomen. Een tweede verzoek met dezelfde key geeft de bestaande printjob terug met status 200.\n\nDe vaste instellingen van de printer gelden, tenzij je in `options` iets anders meestuurt.\n\nIs de printer niet beschikbaar en heeft hij een uitwijkprinter, dan gaat de job daarheen. Dat staat in `requested_printer_id` en in het verloop. Met `fallback: false` zet je dit uit. Stuur `printer_group_id` in plaats van `printer_id` om naar de eerste beschikbare printer van een groep te printen.\n\nKom je van PrintNode? De velden `printerId`, `contentType`, `expireAfter`, `qty` en de header `X-Idempotency-Key` werken ook.\n\nVraagt het recht `print`.","parameters":[{"name":"Idempotency-Key","in":"header","schema":{"type":"string","maxLength":255},"description":"Een unieke waarde per printjob, bijvoorbeeld het ordernummer met het soort document."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrintJobCreate"}}}},"responses":{"201":{"description":"De printjob is aangemaakt.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"200":{"description":"Er bestond al een printjob met deze Idempotency-Key.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"422":{"$ref":"#/components/responses/validation_failed"},"402":{"$ref":"#/components/responses/plan_limit"}},"x-required-scope":"print"}},"/printjobs/{printJob}":{"parameters":[{"name":"printJob","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printjob. Het id of de uuid."}],"get":{"tags":["Printjobs"],"operationId":"getPrintJob","summary":"Bekijk één printjob","responses":{"200":{"description":"De printjob.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."},"delete":{"tags":["Printjobs"],"operationId":"cancelPrintJob","summary":"Annuleer een printjob","description":"Werkt zolang de printjob niet is afgerond. Heeft de client het document al aan de printer gegeven, dan kan het toch nog uit de printer komen.\n\nVraagt het recht `print`.","responses":{"200":{"description":"De printjob is geannuleerd.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"}},"x-required-scope":"print"}},"/printjobs/{printJob}/reprint":{"parameters":[{"name":"printJob","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printjob. Het id of de uuid."}],"post":{"tags":["Printjobs"],"operationId":"reprintPrintJob","summary":"Print een printjob opnieuw","description":"Maakt een nieuwe printjob met hetzelfde document, dezelfde printer en dezelfde opties. Kan alleen als het account documenten bewaart en `reprintable_until` nog niet voorbij is. De nieuwe printjob telt mee in het verbruik.\n\nVraagt het recht `print`.","responses":{"201":{"description":"De nieuwe printjob.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"},"409":{"$ref":"#/components/responses/conflict"},"402":{"$ref":"#/components/responses/plan_limit"}},"x-required-scope":"print"}},"/printjobs/{printJob}/states":{"parameters":[{"name":"printJob","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printjob. Het id of de uuid."}],"get":{"tags":["Printjobs"],"operationId":"listPrintJobStates","summary":"Bekijk het verloop van een printjob","description":"Elke stap met tijdstip, van aanmaken tot geprint. Bij een wachtende printer staat de reden in `message`.\n\nVraagt het recht `read`.","responses":{"200":{"description":"De stappen in volgorde.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PrintJobState"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read"}},"/printer-groups":{"get":{"tags":["Printergroepen"],"operationId":"listPrinterGroups","summary":"Bekijk je printergroepen","responses":{"200":{"description":"Alle printergroepen.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PrinterGroup"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"read","description":"Vraagt het recht `read`."},"post":{"tags":["Printergroepen"],"operationId":"createPrinterGroup","summary":"Maak een printergroep aan","description":"De volgorde van `printer_ids` is de volgorde van voorkeur.\n\nVraagt het recht `manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrinterGroupWrite"}}}},"responses":{"201":{"description":"De printergroep.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrinterGroup"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-required-scope":"manage"}},"/printer-groups/{group}":{"parameters":[{"name":"group","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de printergroep. Het id of de uuid."}],"get":{"tags":["Printergroepen"],"operationId":"getPrinterGroup","summary":"Bekijk één printergroep","responses":{"200":{"description":"De printergroep.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrinterGroup"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"read","description":"Vraagt het recht `read`."},"put":{"tags":["Printergroepen"],"operationId":"updatePrinterGroup","summary":"Wijzig een printergroep","description":"Stuur alleen mee wat je wilt wijzigen. `printer_ids` vervangt de hele lijst.\n\nVraagt het recht `manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrinterGroupWrite"}}}},"responses":{"200":{"description":"De printergroep.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PrinterGroup"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-required-scope":"manage"},"delete":{"tags":["Printergroepen"],"operationId":"deletePrinterGroup","summary":"Verwijder een printergroep","description":"De printers zelf blijven staan.\n\nVraagt het recht `manage`.","responses":{"204":{"description":"De printergroep is verwijderd."},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage"}},"/pairing-codes":{"post":{"tags":["Computers"],"operationId":"createPairingCode","summary":"Maak een koppelcode aan","description":"Met de code koppelt de client een computer aan het account, zonder wachtwoord. Geldig voor 15 minuten en één keer te gebruiken. Een nieuwe code maakt de vorige ongeldig. Als integrator maak je zo in je eigen software een code voor een sub-account.\n\nVraagt het recht `manage`.","responses":{"201":{"description":"De koppelcode.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string","examples":["HS34-SN8S"]},"expires_at":{"type":"string","format":"date-time"}}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage"}},"/account/children":{"get":{"tags":["Sub-accounts"],"operationId":"listChildAccounts","summary":"Bekijk je sub-accounts","responses":{"200":{"description":"Alle sub-accounts.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChildAccount"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"manage","description":"Vraagt het recht `manage`."},"post":{"tags":["Sub-accounts"],"operationId":"createChildAccount","summary":"Maak een sub-account aan","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChildAccountCreate"}}}},"responses":{"201":{"description":"Het sub-account.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ChildAccount"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-required-scope":"manage","description":"Vraagt het recht `manage`."}},"/account/children/{child}":{"parameters":[{"name":"child","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van het sub-account. Het id of de uuid."}],"get":{"tags":["Sub-accounts"],"operationId":"getChildAccount","summary":"Bekijk één sub-account","responses":{"200":{"description":"Het sub-account.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ChildAccount"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage","description":"Vraagt het recht `manage`."},"delete":{"tags":["Sub-accounts"],"operationId":"deleteChildAccount","summary":"Verwijder een sub-account","description":"Verwijdert ook de computers, printers en printjobs van het sub-account en trekt alle tokens in.\n\nVraagt het recht `manage`.","responses":{"204":{"description":"Het sub-account is verwijderd."},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage"}},"/webhooks":{"get":{"tags":["Webhooks"],"operationId":"listWebhooks","summary":"Bekijk je webhooks","responses":{"200":{"description":"Alle webhooks van het account.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"}},"x-required-scope":"manage","description":"Vraagt het recht `manage`."},"post":{"tags":["Webhooks"],"operationId":"createWebhook","summary":"Maak een webhook aan","description":"Het geheim staat alleen in dit antwoord. Je controleert er de handtekening van elk bericht mee. Alleen publieke https-adressen zijn toegestaan.\n\nVraagt het recht `manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}},"responses":{"201":{"description":"De webhook, met het geheim.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookWithSecret"}}}}}},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"422":{"$ref":"#/components/responses/validation_failed"}},"x-required-scope":"manage"}},"/webhooks/{webhook}":{"parameters":[{"name":"webhook","in":"path","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"uuid"}]},"description":"Het id van de webhook. Het id of de uuid."}],"delete":{"tags":["Webhooks"],"operationId":"deleteWebhook","summary":"Verwijder een webhook","responses":{"204":{"description":"De webhook is verwijderd."},"401":{"$ref":"#/components/responses/unauthenticated"},"403":{"$ref":"#/components/responses/forbidden"},"429":{"$ref":"#/components/responses/rate_limited"},"404":{"$ref":"#/components/responses/not_found"}},"x-required-scope":"manage","description":"Vraagt het recht `manage`."}}},"webhooks":{"printjob.printing":{"post":{"tags":["Webhooks"],"summary":"Printjob wordt geprint","operationId":"onPrintjobPrinting","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.printing"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"printjob.waiting":{"post":{"tags":["Webhooks"],"summary":"Printjob wacht bij de printer","operationId":"onPrintjobWaiting","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.waiting"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"printjob.done":{"post":{"tags":["Webhooks"],"summary":"Printjob is geprint","operationId":"onPrintjobDone","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.done"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"printjob.error":{"post":{"tags":["Webhooks"],"summary":"Printjob is mislukt","operationId":"onPrintjobError","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.error"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"printjob.expired":{"post":{"tags":["Webhooks"],"summary":"Printjob is verlopen","operationId":"onPrintjobExpired","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.expired"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"printjob.cancelled":{"post":{"tags":["Webhooks"],"summary":"Printjob is geannuleerd","operationId":"onPrintjobCancelled","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"printjob.cancelled"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/PrintJob"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"computer.connected":{"post":{"tags":["Webhooks"],"summary":"Computer is verbonden","operationId":"onComputerConnected","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"computer.connected"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/Computer"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}},"computer.disconnected":{"post":{"tags":["Webhooks"],"summary":"Computer is niet meer verbonden","operationId":"onComputerDisconnected","description":"De header `X-Printmelo-Signature` bevat `t=<tijdstip>,v1=<handtekening>`. De handtekening is de HMAC-SHA256 van `<tijdstip>.<body>` met het geheim van de webhook. Antwoord binnen 10 seconden met een 2xx-status. Anders volgen vijf nieuwe pogingen.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","event","created_at","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Uniek per bericht. Gebruik dit om dubbele berichten te herkennen."},"event":{"type":"string","const":"computer.disconnected"},"created_at":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/Computer"}}}}}},"responses":{"200":{"description":"Ontvangen."}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"De API-key als Bearer-token."},"basic":{"type":"http","scheme":"basic","description":"De API-key als gebruikersnaam, met een leeg wachtwoord."}},"parameters":{"state":{"name":"state","in":"query","schema":{"$ref":"#/components/schemas/PrintJobStateName"},"description":"Alleen printjobs in deze toestand."},"limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"description":"Aantal per pagina."},"cursor":{"name":"cursor","in":"query","schema":{"type":"string"},"description":"De `next_cursor` uit het vorige antwoord."}},"responses":{"unauthenticated":{"description":"De API-key ontbreekt of is ongeldig.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"forbidden":{"description":"Deze key geeft geen toegang tot dit endpoint, of mist het recht dat het endpoint vraagt.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"not_found":{"description":"Dit bestaat niet in jouw account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"validation_failed":{"description":"De invoer klopt niet. Het veld `errors` zegt per veld wat er mis is.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"plan_limit":{"description":"De limiet van je abonnement is bereikt of je proefperiode is afgelopen.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"conflict":{"description":"De actie past niet bij de huidige toestand, bijvoorbeeld een printjob die al is afgerond.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"rate_limited":{"description":"Te veel verzoeken. Probeer het later opnieuw.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"key_budget":{"description":"Deze API-key heeft zijn dagbudget voor printjobs bereikt. Morgen kan hij weer printen.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["message","code"],"properties":{"message":{"type":"string","description":"Een leesbare melding, in de taal van de header `Accept-Language`."},"code":{"type":"string","enum":["unauthenticated","forbidden","not_found","validation_failed","plan_limit","conflict","rate_limited","key_budget","server_error"],"description":"Een vaste code waar je koppeling op kan sturen."}}},"ValidationError":{"allOf":[{"$ref":"#/components/schemas/Error"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Per veld de meldingen."}}},"Account":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"name":{"type":"string"},"reference":{"type":["string","null"]},"parent_id":{"type":["integer","null"],"description":"Gevuld bij een sub-account."},"is_integrator":{"type":"boolean","description":"Mag dit account sub-accounts beheren?"},"computers":{"type":"integer"},"printers":{"type":"integer"},"plan":{"type":["object","null"],"description":"Leeg voor een sub-account met een eigen key: het pakket regelt de integrator.","properties":{"key":{"type":"string"},"name":{"type":"string"},"trial_ends_at":{"type":["string","null"],"format":"date-time"},"printjobs_used":{"type":"integer","description":"Printjobs in deze kalendermaand."},"printjobs_limit":{"type":["integer","null"],"description":"Leeg is onbeperkt."},"computers_limit":{"type":["integer","null"],"description":"Leeg is onbeperkt."}}},"key":{"type":["object","null"],"description":"De API-key van dit verzoek.","properties":{"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["read","print","manage"]},"description":"De rechten van deze key."},"printjobs_today":{"type":"integer","description":"Printjobs die deze key vandaag heeft verstuurd."},"daily_print_limit":{"type":["integer","null"],"description":"Het dagbudget van deze key. Leeg is onbeperkt."}}}}},"Computer":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"name":{"type":"string"},"hostname":{"type":["string","null"]},"os":{"type":["string","null"],"examples":["windows","macos"]},"client_version":{"type":["string","null"]},"state":{"type":"string","enum":["connected","disconnected"]},"virtual":{"type":"boolean","description":"De oefencomputer: hoort bij de oefenprinter, heeft geen client en telt niet mee in je pakket."},"last_seen_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"Printer":{"type":"object","properties":{"id":{"type":"integer","description":"Blijft gelijk, ook als de printer even van de computer verdwijnt."},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"computer_id":{"type":"integer"},"name":{"type":"string","description":"De naam op de computer."},"alias":{"type":["string","null"],"description":"De eigen naam uit het dashboard."},"description":{"type":["string","null"]},"is_default":{"type":"boolean"},"state":{"type":"string","enum":["online","offline"]},"capabilities":{"type":["object","null"],"description":"Wat de printer kan, zoals gemeld door de computer.","properties":{"pdf":{"type":"boolean"},"raw":{"type":"boolean"},"image":{"type":"boolean"},"model":{"type":["string","null"]},"papers":{"type":"array","items":{"type":"string"},"description":"Papierformaten die je in `paper` kunt gebruiken."},"bins":{"type":"array","items":{"type":"string"},"description":"Lades die je in `bin` kunt gebruiken."},"duplex":{"type":"boolean"},"color":{"type":"boolean"}}},"fallback_printer_id":{"type":["integer","null"],"description":"De uitwijkprinter, in te stellen in het dashboard."},"default_options":{"$ref":"#/components/schemas/PrintOptions"},"created_at":{"type":"string","format":"date-time"}}},"PrintOptions":{"type":"object","description":"Gelden voor PDF en afbeeldingen. Raw-data gaat ongewijzigd naar de printer. Onbekende opties worden genegeerd.","properties":{"paper":{"type":"string","examples":["A4","A6","Custom.100x150mm"],"description":"Papierformaat."},"duplex":{"type":"string","enum":["one-sided","long-edge","short-edge"]},"fit_to_page":{"type":"boolean","description":"Pas het document aan op het papierformaat."},"bin":{"type":"string","examples":["tray-1"],"description":"Papierlade. De lades van een printer staan in `capabilities.bins`."},"color":{"type":"boolean","description":"`false` print in zwart-wit."},"rotate":{"type":"integer","enum":[0,90,180,270],"description":"Draai het document, in graden."},"pages":{"type":"string","examples":["1-3,5"],"description":"Alleen deze pagina's."}}},"PrintJobStateName":{"type":"string","enum":["new","sent","downloaded","printing","spooled","done","error","expired","cancelled"],"description":"`new`: ontvangen. `sent`: seintje naar de computer verstuurd. `printing`: opgepakt door de client. `spooled`: in de wachtrij van de printer. `done`: geprint volgens de printer. `error`: mislukt, zie `state_message`. `expired`: niet op tijd opgepakt. `cancelled`: geannuleerd."},"PrintJobCreate":{"type":"object","required":["title","content_type","content"],"description":"Stuur `printer_id` of `printer_group_id` mee.","properties":{"printer_id":{"type":"integer"},"printer_group_id":{"type":"integer","description":"Print naar de eerste beschikbare printer van deze groep."},"fallback":{"type":"boolean","default":true,"description":"Gebruik de uitwijkprinter als de printer niet beschikbaar is."},"title":{"type":"string","maxLength":255,"examples":["Verzendlabel 10482"]},"content_type":{"type":"string","enum":["pdf_uri","pdf_base64","raw_uri","raw_base64","image_uri","image_base64"],"description":"`pdf_*` voor een PDF, `image_*` voor een PNG of JPEG, `raw_*` voor printertaal zoals ZPL. `*_uri` haalt de client zelf op, `*_base64` stuur je mee. Afbeeldingen vragen client 0.2.0 of nieuwer."},"content":{"type":"string","description":"Een http(s)-URL, of het document in base64 (maximaal 20 MB)."},"source":{"type":"string","maxLength":255,"description":"Vrije tekst, bijvoorbeeld de naam van je software."},"copies":{"type":"integer","minimum":1,"maximum":999,"default":1},"options":{"$ref":"#/components/schemas/PrintOptions"},"expire_after":{"type":"integer","minimum":1,"maximum":1209600,"default":1209600,"description":"Seconden waarna een niet-opgepakte printjob verloopt."}},"examples":[{"printer_id":12,"title":"Verzendlabel 10482","content_type":"pdf_uri","content":"https://example.com/labels/10482.pdf"}]},"PrintJob":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"printer_id":{"type":"integer","description":"De printer waar de job naartoe is gegaan."},"requested_printer_id":{"type":["integer","null"],"description":"Gevuld als de job is omgeleid: voor deze printer was hij bedoeld."},"printer_group_id":{"type":["integer","null"],"description":"Gevuld als de job naar een groep is gestuurd."},"reprint_of_id":{"type":["integer","null"],"description":"Het id van de printjob waarvan dit een herhaling is."},"reprintable_until":{"type":["string","null"],"format":"date-time","description":"Tot dit tijdstip kun je de printjob opnieuw printen. Leeg als het document niet bewaard is."},"computer_id":{"type":"integer"},"printer":{"type":["object","null"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"alias":{"type":["string","null"]},"state":{"type":"string","enum":["online","offline","removed"]}}},"title":{"type":"string"},"source":{"type":["string","null"]},"content_type":{"type":"string","enum":["pdf_uri","pdf_base64","raw_uri","raw_base64","image_uri","image_base64"]},"copies":{"type":"integer"},"options":{"$ref":"#/components/schemas/PrintOptions"},"practice":{"type":"boolean","description":"Een job voor de oefenprinter: er is niets geprint."},"state":{"$ref":"#/components/schemas/PrintJobStateName"},"state_message":{"type":["string","null"],"description":"De foutmelding, of de reden dat de printer wacht."},"latency_ms":{"type":["integer","null"],"description":"Milliseconden van aanmaken tot geprint. Gevuld bij `done`."},"expires_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"PrintJobPage":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PrintJob"}},"next_cursor":{"type":["string","null"],"description":"Geef dit mee als `cursor` voor de volgende pagina. Leeg op de laatste pagina."}}},"PrintJobState":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/PrintJobStateName"},"message":{"type":["string","null"]},"timings":{"type":["object","null"],"description":"Door de client gemeten tijden in milliseconden.","properties":{"queue_ms":{"type":"integer","description":"Wachten op een eerdere job voor dezelfde printer."},"fetch_ms":{"type":"integer","description":"Document ophalen."},"print_ms":{"type":"integer","description":"Afleveren aan de wachtrij van de computer."},"spool_ms":{"type":"integer","description":"Wachten en printen bij de printer."}}},"created_at":{"type":"string","format":"date-time"},"created_at_ms":{"type":["integer","null"],"description":"Hetzelfde tijdstip in milliseconden sinds 1970."}}},"PrinterGroup":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"name":{"type":"string"},"printer_ids":{"type":"array","items":{"type":"integer"},"description":"In volgorde van voorkeur."},"created_at":{"type":"string","format":"date-time"}}},"PrinterGroupWrite":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"printer_ids":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"integer"}}}},"ChildAccount":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"name":{"type":"string"},"reference":{"type":["string","null"],"description":"Je eigen kenmerk voor deze klant."},"computers":{"type":"integer"},"printers":{"type":"integer"},"created_at":{"type":"string","format":"date-time"}}},"ChildAccountCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":255},"reference":{"type":"string","maxLength":255,"description":"Uniek binnen jouw account, bijvoorbeeld je klantnummer."}}},"WebhookCreate":{"type":"object","required":["url","events"],"properties":{"url":{"type":"string","format":"uri","examples":["https://example.com/webhooks/printmelo"]},"events":{"type":"array","minItems":1,"items":{"type":"string","enum":["printjob.printing","printjob.waiting","printjob.done","printjob.error","printjob.expired","printjob.cancelled","computer.connected","computer.disconnected"]}}}},"Webhook":{"type":"object","properties":{"id":{"type":"integer"},"uuid":{"type":"string","format":"uuid","description":"Werkt overal waar een id in de URL staat."},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["printjob.printing","printjob.waiting","printjob.done","printjob.error","printjob.expired","printjob.cancelled","computer.connected","computer.disconnected"]}},"active":{"type":"boolean","description":"Gaat uit na 20 mislukte afleveringen op rij."},"last_success_at":{"type":["string","null"],"format":"date-time"},"last_failure_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"WebhookWithSecret":{"allOf":[{"$ref":"#/components/schemas/Webhook"}],"properties":{"secret":{"type":"string","description":"Alleen zichtbaar bij het aanmaken."}}}}}}