You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/overview/pdf-accessibility-auto-tag-api/gettingstarted.md
+45-36Lines changed: 45 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Getting Started | PDF Accessibility Auto-Tag API | Adobe PDF Services
3
3
---
4
4
5
-
# Getting Started
5
+
# Getting Started
6
6
7
7
<p>
8
8
PDF Accessibility Auto-Tag API assists in the process of improving accessibility in individual PDFs via auto-tagging, adding document structure tags to the PDF file that are used to read a document's text and presenting it in a way that makes sense to users using assistive technology. The API is accessible through SDKs which help you get up and running quickly. Once you've received your developer credential, download and set up one of the sample projects. After you're familiar with the APIs, leverage the samples in your own server-side code.
@@ -14,33 +14,34 @@ The SDK only supports server-based use cases where credentials are saved securel
14
14
15
15
## Step 1 : Getting the access token
16
16
17
-
PDF Services API endpoints are authenticated endpoints. Getting an access token is a two-step process:
17
+
PDF Services API endpoints are authenticated endpoints. Getting an access token is a two-step process:
18
18
19
19
1.**Get Credentials** Invoking PDF Services API requires an Adobe-provided credential. To get one, [click here](https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=pdf-services-api), and complete the workflow. Be sure to copy and save the credential values to a secure location.
20
+
20
21
2.**Retrieve Access Token** The PDF Services APIs require an access_token to authorize the request. Use the "Get AccessToken" API from the Postman Collection with your client_id, client_secret (mentioned in the pdfservices-api-credentials.json file downloaded in 1) to get the access_token OR directly use the below mentioned cURL to get the access_token.
@@ -54,7 +55,7 @@ curl --location --request POST 'https://pdf-services.adobe.io/assets' \
54
55
55
56
2. On getting a `200` response status from the above API, use the `uploadUri` field in the response body of the above API to upload the asset directly to the cloud provider using a PUT API call. You will also get an `assetID` field which will be used in creating the job.
@@ -64,19 +65,19 @@ curl --location -g --request PUT 'https://dcplatformstorageservice-prod-us-east-
64
65
--data-binary '@{{Placeholder for file path}}'
65
66
```
66
67
67
-
## Step 3 : Creating the job
68
+
## Step 3 : Creating the job
68
69
69
-
To create a job for the operation, please use the `assetID` obtained in Step 2 in the API request body. On successful job submission you will get a status code of `201` and a response header `location` which will be used for polling.
70
+
To create a job for the operation, please use the `assetID` obtained in Step 2 in the API request body. On successful job submission you will get a status code of `201` and a response header `location` which will be used for polling.
70
71
71
72
For creating the job, please refer to the corresponding API spec for the particular [PDF Operation](../../../apis).
72
73
73
74
## Step 4 : Fetching the status
74
75
75
-
Once the job is successfully created, you need to poll the at the `location` returned in response header of Step 3 by using the following API
76
+
Once the job is successfully created, you need to poll the at the `location` returned in response header of Step 3 by using the following API
76
77
77
78
You can read more about the API in detail [here](../../../apis/#operation/pdfoperations.compresspdf.jobstatus).
@@ -91,7 +92,7 @@ curl --location -g --request GET 'https://pdf-services.adobe.io/operation/compre
91
92
Instead of using the status API to check the job status, you have the option to receive job completion notifications through Webhook. For more information, please refer the <ahref="../../pdf-services-api/howtos/webhook-notification/">documentation</a>.
92
93
</div>
93
94
94
-
## Step 5 : Downloading the asset
95
+
## Step 5 : Downloading the asset
95
96
96
97
On getting `200` response code from the poll API, you will receive a `status` field in the response body which can either be `in progress`, `done` or `failed`.
97
98
@@ -101,15 +102,15 @@ If the `status` field is `done` the response body will also have a download pre-
101
102
102
103
You can read more about the API in detail [here](../../../apis/#operation/asset.get).
curl --location -g --request GET'https://dcplatformstorageservice-prod-us-east-1.s3-accelerate.amazonaws.com/b37fd583-1ab6-4f49-99ef-d716180b5de4?X-Amz-Security-Token={{Placeholder for X-Amz-Security-Token}}&X-Amz-Algorithm={{Placeholder for X-Amz-Algorithm}}&X-Amz-Date={{Placeholder for X-Amz-Date}}&X-Amz-SignedHeaders={{Placeholder for X-Amz-SignedHeaders}}&X-Amz-Expires={{Placeholder for X-Amz-Expires}}&X-Amz-Credential={{Placeholder for X-Amz-Credential}}&X-Amz-Signature={{Placeholder for X-Amz-Signature}}'
110
111
```
111
112
112
-
## There you go! Your job is completed in 5 simple steps.
113
+
## There you go! Your job is completed in 5 simple steps.
113
114
114
115
## SDK
115
116
@@ -171,10 +172,10 @@ For clients using SDK version upto 2.x :
171
172
172
173
Jump start your development by bookmarking or downloading the following key resources:
4.[Java library](https://www.adobe.com/go/pdftoolsapi_java_maven). The Maven project contains the .jar file.
178
179
179
180
#### Authentication
180
181
@@ -183,7 +184,7 @@ Once you complete the [Getting Credentials](https://documentservices.adobe.com/d
183
184
-**Personalized Download**: Downloads the zip which contains `adobe-dc-pdf-services-sdk-java-samples` with a preconfigured `pdfservices-api-credentials.json` file.
184
185
-**Non Personalized Download**: Downloads the `pdfservices-api-credentials.json` with your preconfigured credentials.
185
186
186
-
After downloading the zip, you can run the samples in the zip directly by setting up the two environment variables `PDF_SERVICES_CLIENT_ID` and `PDF_SERVICES_CLIENT_SECRET` by running the following cammands :
187
+
After downloading the zip, you can run the samples in the zip directly by setting up the two environment variables `PDF_SERVICES_CLIENT_ID` and `PDF_SERVICES_CLIENT_SECRET` by running the following commands:
187
188
188
189
-**Windows:**
189
190
-`set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
@@ -195,7 +196,7 @@ After downloading the zip, you can run the samples in the zip directly by settin
195
196
196
197
**Example pdfservices-api-credentials.json file**
197
198
198
-
```json
199
+
```json
199
200
{
200
201
"client_credentials": {
201
202
"client_id": "<YOUR_CLIENT_ID>",
@@ -245,10 +246,10 @@ Command line execution is not mandatory. You can import the samples Maven projec
245
246
246
247
For security reasons you may wish to confirm the installer's authenticity. To do so,
247
248
248
-
1.After installing the package, navigate to the `.jar.sha1` file.
249
-
2.Calculate the hash with any 3rd party utility.
250
-
3.Find and open PDF Services sha1 file. Note: if you're using Maven, look in the .m2 directory.
251
-
4.Verify the hash you generated matches the value in the .sha1 file.
249
+
1. After installing the package, navigate to the `.jar.sha1` file.
250
+
2. Calculate the hash with any 3rd party utility.
251
+
3. Find and open PDF Services sha1 file. Note: if you're using Maven, look in the .m2 directory.
252
+
4. Verify the hash you generated matches the value in the .sha1 file.
252
253
253
254
```
254
255
5d49322ced35a8195378a7ed297b4fb721780736
@@ -345,7 +346,7 @@ After downloading the zip, you can run the samples in the zip directly by settin
345
346
346
347
**Example pdfservices-api-credentials.json file**
347
348
348
-
```json
349
+
```json
349
350
{
350
351
"client_credentials": {
351
352
"client_id": "<YOUR_CLIENT_ID>",
@@ -456,7 +457,7 @@ After downloading the zip, you can run the samples in the zip directly by settin
456
457
457
458
**Example pdfservices-api-credentials.json file**
458
459
459
-
```json
460
+
```json
460
461
{
461
462
"client_credentials": {
462
463
"client_id": "<YOUR_CLIENT_ID>",
@@ -478,25 +479,33 @@ Running any sample or custom code requires the following steps:
478
479
479
480
The @adobe/pdfservices-node-sdk npm package automatically downloads when you build the sample project.
480
481
481
-
```
482
+
```
482
483
npm install --save @adobe/pdfservices-node-sdk
483
484
```
484
485
485
486
##### Running the samples
486
487
487
488
The quickest way to get up and running is to download the code samples during the Getting Credentials workflow. These samples provide everything from ready-to-run sample code, an embedded credential json file, and pre-configured connections to dependencies.
0 commit comments