[{"data":1,"prerenderedAt":93},["Reactive",2],{"/guides/java/retrofit/adding-a-custom-header-or-footer":3,"/guides/java/retrofit/adding-a-custom-header-or-footer-related":59},{"_path":4,"_dir":5,"_draft":6,"_partial":6,"_locale":7,"title":8,"description":9,"language":10,"library":11,"property":12,"output":13,"related":14,"default":6,"body":17,"_type":54,"_id":55,"_source":56,"_file":57,"_extension":58},"/guides/java/retrofit/adding-a-custom-header-or-footer","retrofit",false,"","Adding a custom header or footer","Learn how to add custom headers and footers to your PDFs using Java and the Retrofit library. This guide offers detailed steps with code samples in Java and the Retrofit library, showing how to customize PDF appearance with headers and footers.","Java","Retrofit","header","pdf",[15,16],"loading-css-from-a-string","loading-css-from-a-url",{"type":18,"children":19,"toc":51},"root",[20,28,33,46],{"type":21,"tag":22,"props":23,"children":24},"element","p",{},[25],{"type":26,"value":27},"text","In this guide, we'll show you how to add custom headers and footers to your PDFs using Java and the Retrofit library.",{"type":21,"tag":22,"props":29,"children":30},{},[31],{"type":26,"value":32},"When generating PDFs, you might want to add custom headers and footers to your documents for branding or informational purposes.",{"type":21,"tag":34,"props":35,"children":40},"pre",{"className":36,"code":38,"language":39,"meta":7},[37],"language-java","import retrofit2.*;\nimport retrofit2.converter.gson.GsonConverterFactory;\nimport com.google.gson.*;\nimport java.io.IOException;\n\n// You can get an API key at https://pdfshift.io\npublic interface PdfShiftApi {\n    @POST(\"v3/convert/pdf\")\n    Call\u003CResponseBody> convertToPdf(\n        @Header(\"X-API-Key\") String apiKey,\n        @Body JsonObject body\n    );\n}\n\n// Usage\nGson gson = new GsonBuilder().create();\nRetrofit retrofit = new Retrofit.Builder()\n    .baseUrl(\"https://api.pdfshift.io/\")\n    .addConverterFactory(GsonConverterFactory.create(gson))\n    .build();\n\nPdfShiftApi api = retrofit.create(PdfShiftApi.class);\n\nJsonObject payload = new JsonObject();\npayload.addProperty(\"source\", \"https://www.example.com\");\nJsonObject header = new JsonObject();\nheader.addProperty(\"content\", \"\u003Cdiv style='text-align: center;'>Header Content\u003C/div>\");\nheader.addProperty(\"height\", \"20mm\");\nJsonObject footer = new JsonObject();\nfooter.addProperty(\"content\", \"\u003Cdiv style='text-align: center;'>Footer Content\u003C/div>\");\nfooter.addProperty(\"height\", \"20mm\");\npayload.add(\"header\", header);\npayload.add(\"footer\", footer);\n\nCall\u003CResponseBody> call = api.convertToPdf(\"sk_xxxxxxxxxxxx\", payload);\nResponse\u003CResponseBody> response = call.execute();\n\n// Handle errors:\nif (!response.isSuccessful()) {\n    throw new IOException(\"Request failed with status code \" + response.code());\n}\n\nResponseBody responseBody = response.body();\nif (responseBody != null) {\n    java.nio.file.Files.write(\n        java.nio.file.Paths.get(\"result.pdf\"), \n        responseBody.bytes()\n    );\n}\n\nSystem.out.println(\"The PDF document was generated and saved to result.pdf\");\n","java",[41],{"type":21,"tag":42,"props":43,"children":44},"code",{"__ignoreMap":7},[45],{"type":26,"value":38},{"type":21,"tag":22,"props":47,"children":48},{},[49],{"type":26,"value":50},"This allows you to add consistent branding elements to all your generated PDF documents.",{"title":7,"searchDepth":52,"depth":52,"links":53},2,[],"markdown","content:guides:java:retrofit:adding-a-custom-header-or-footer.md","content","guides/java/retrofit/adding-a-custom-header-or-footer.md","md",[60,64,65,69,73,77,81,85,89],{"_path":61,"title":62,"language":10,"library":11,"_id":63},"/guides/java/retrofit/accessing-secured-pages","Accessing secured pages","content:guides:java:retrofit:accessing-secured-pages.md",{"_path":4,"title":8,"language":10,"library":11,"_id":55},{"_path":66,"title":67,"language":10,"library":11,"_id":68},"/guides/java/retrofit/adding-a-text-watermark","Adding a text watermark","content:guides:java:retrofit:adding-a-text-watermark.md",{"_path":70,"title":71,"language":10,"library":11,"_id":72},"/guides/java/retrofit/adding-an-image-watermark","Adding an image watermark","content:guides:java:retrofit:adding-an-image-watermark.md",{"_path":74,"title":75,"language":10,"library":11,"_id":76},"/guides/java/retrofit/avoid-conversion-on-error","Avoid conversion on error","content:guides:java:retrofit:avoid-conversion-on-error.md",{"_path":78,"title":79,"language":10,"library":11,"_id":80},"/guides/java/retrofit/convert-html-to-pdf-from-a-url","Convert HTML to PDF from a URL","content:guides:java:retrofit:convert-html-to-pdf-from-a-url.md",{"_path":82,"title":83,"language":10,"library":11,"_id":84},"/guides/java/retrofit/convert-html-to-pdf-from-raw-html","Convert HTML to PDF from raw HTML","content:guides:java:retrofit:convert-html-to-pdf-from-raw-html.md",{"_path":86,"title":87,"language":10,"library":11,"_id":88},"/guides/java/retrofit/define-a-time-limit","Define a time limit","content:guides:java:retrofit:define-a-time-limit.md",{"_path":90,"title":91,"language":10,"library":11,"_id":92},"/guides/java/retrofit/exporting-only-a-specific-set-of-pages","Exporting only a specific set of pages","content:guides:java:retrofit:exporting-only-a-specific-set-of-pages.md",1780405109593]