Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added howtos and release notes for accessibility checker GA #905

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: PDF Accessibility Checker | How Tos | PDF Services API | Adobe PDF Services
---
<InlineAlert slots="text"/>

PDF Accessibility Checker is currently accessible through the REST API only.
rajatgaur30 marked this conversation as resolved.
Show resolved Hide resolved

# PDF Accessibility Checker

Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. Additional human remediation may be required to ensure that the reading order of elements is correct and that alternative text tags properly convey the meaning of an image. The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro.

## Input Documents : **Required**

Supported format is PDF (application/pdf). Input PDF with version 1.6 and above is supported.
rajatgaur30 marked this conversation as resolved.
Show resolved Hide resolved

### Input Document
rajatgaur30 marked this conversation as resolved.
Show resolved Hide resolved

A PDF document for which accessibility to be checked.

## API Parameters

### Page start (_pageStart_)

The parameter allows for the specification of the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1.

### Page end (_pageEnd_)

The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.

## REST API

See our public API Reference for [PDF Accessibility Checker API](../../../apis/#tag/PDF-Accessibility-Checker).

## Check accessibility for specified pages

The sample below performs accessibility checker operation for specified pages of a given PDF.

Please refer the [API usage guide](../gettingstarted.md) to understand how to use our APIs.

<CodeBlock slots="heading, code" repeat="1" languages="REST API" />

#### REST API

```javascript
curl --location --request POST 'https://pdf-services.adobe.io/operation/accessibilitychecker' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--data-raw '{
"assetID": "urn:aaid:AS:UE1:54cbf87f-d7f5-4918-8e4b-9f1878678e68",
"pageStart":1,
"pageEnd":5
}'
```
4 changes: 4 additions & 0 deletions src/pages/overview/releasenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ Upgrading to the latest SDK should not break existing applications.

## Change history

### July 17, 2024; PDF Accessibility Checker API Added

- Added [PDF Accessibility Checker](../pdf-services-api/howtos/pdf-accessibility-checker-api/) operation in PDF Services API to check accessibility on specified pages of PDF document.

### July 08, 2024; PDF Watermark API Added

- Added [PDF Watermark](../pdf-services-api/howtos/pdf-watermark-api/) operation in PDF Services API to add a watermark on specified pages of PDF document.
Expand Down