The Photon Admin API.
Automate what the admin dashboard does by hand: manage the people you invite, then pull finished portraits straight into your card-production workflow. Token-authenticated, scoped API access, documented interactively in the Photon admin console.
Available on every Photon edition - Lite, Business and Enterprise; Enterprise adds bespoke integration.
See it work
The admin console and the API, in forty-two seconds
One take of the whole operation: invite a workforce in one click, watch validated portraits arrive, and pull them into card production through the same API.
Authentication
1 endpointAccess is OAuth2: obtain an access token and present it on every request.
- POST
/auth/tokenObtain an access token
API keys are created and managed by your administrators in the Photon admin console, under Settings, API Keys.
Photos
5 endpointsRetrieve finished portraits one at a time or as a bulk ZIP, and delete photos when your retention rules say so.
- GET
/photosList photos - GET
/photos/{identifier}Download a single photo - DELETE
/photos/{identifier}Delete a user's photos - POST
/photos/bulk-downloadBulk download photos as a ZIP - POST
/photos/bulk-deleteBulk delete photos
Users
10 endpointsCreate the people who should submit a photo - individually or in bulk - and enable, disable or remove them as your population changes.
- GET
/usersList users - POST
/usersCreate a user - POST
/users/bulkBulk create users - GET
/users/{identifier}Get a user by identifier - DELETE
/users/{identifier}Delete a user - POST
/users/{identifier}/enableEnable a user - POST
/users/{identifier}/disableDisable a user - POST
/users/bulk-enableBulk enable users - POST
/users/bulk-disableBulk disable users - POST
/users/bulk-deleteBulk delete users
The full interactive reference, including request and response schemas, ships inside the Photon admin console under Settings, API Docs.
Test a photo, then automate the rest.
Run a sample photo through the checks in your browser, then compare editions when you are ready.