API
POST /analyze
- baseFileUrl - url to base pdf file
- testFileUrl - url to test pdf file
- apiKey - your api key
- webhookUrl - optional url for a webhook call
- ignoreRegions - optional list of regions that should be ignored
- x - x coordinate in pdf coordinate system
- y - y coordinate in pdf coordinate system
- width
- height
- page - 0 based page number
response
- 401 - invalid api key or no quota left
- 200 - job queued
- jobId - job identifier
- status - current job status
example
curl -X POST http://pdf-regression.com/api/pdf/analyze -H "Content-Type: application/json"
-d "{\"baseFileUrl\": \"__URL1__\", \"testFileUrl\": \"__URL2__\", \"apiKey\": \"__API_KEY__\",
\"ignoreRegions\": []}"
GET /analyze/status
- jobId - job identifier
- apiKey - your api key
response
- jobId - job identifier
- status - current job status
- report - comparison result report in json form
- fullReportUrl - url to full html report with visual differences
example
curl -X GET http://pdf-regression.com/api/pdf/analyze/status -H "Content-Type: application/json"
-d "{\"jobId\":\"__JOB_ID__"\", \"apiKey\": \"__API_KEY__\"}"