The Percy API is based on the JSON API standard and organized around the REST design.
API base URL
https://percy.io/api/v1
The Percy API uses API tokens to authenticate. They are passed in as a HTTP Authorization request headers.
Authorization header format
Authorization: Token ${PERCY_TOKEN}
Percy currently authenticates with three project token types:
- Write-only
- Read-only
- Full-access
The differences are outlined below:
The tokens for a particular project can be found on its Project Settings page.
Project token panel in Project Settings