Synchrotron Data Analysis Software Platform
Software
All softwareBrowse the full catalogueImagingCT, Ptycho, BCDI, HoloDiffraction & scatteringPDF, SAXS, BMX, XPCSSpectroscopyXAS, XRF, XRS, PCA/LCFData toolsConversion, cropping and formatsArtificial intelligenceSparse-view CT, training and inference
Download
Download centreAll software packagesDownload & installLicence, checksums and setup
Documentation
DocumentationAll documentationSoftware manualsUser guidesAPI guidePublic and maintainer APIsDownload & installChecksums and setupDAISY user docs ↗Framework and algorithms
NewsTeamAbout DAISYTORCH platform ↗
中文
DAISY Data Processing Software

Official site of HEPS DAISY data processing software: introductions, online access and downloads.

Navigation
  • Software
  • Download
  • Documentation
  • News
  • Team
  • About DAISY
  • Admin
Links
  • TORCH platform ↗
Institute of High Energy Physics, CAS · HEPS Big Data Centre
DAISY · API

API guide

Public endpoints expose software and versions and issue download links. Maintainers use a personal token to update assigned software, media and artifacts.

DocumentationManualsAPI guideDownload & install

Base URL and authentication

Base URL: https://<site-domain>/api/v1
Authorization: Bearer daisy_xxxxxxxxxxxxxxxxx

Maintainers sign in with their existing admin account and create a personal token. The plaintext token is shown once; only its hash is stored.

1. Sign in and create a token
curl -c cookies.txt -X POST \
  https://<site-domain>/api/v1/admin/login \
  -H 'Content-Type: application/json' \
  -d '{"username":"<user>","password":"<password>"}'

curl -b cookies.txt -X POST \
  https://<site-domain>/api/v1/api-tokens \
  -H 'Content-Type: application/json' \
  -d '{"name":"my-script","expires_in_days":180}'
2. Use the token
export DAISY_API_TOKEN=daisy_xxxxx
export DAISY_API_BASE=https://<site-domain>/api/v1

curl -H "Authorization: Bearer $DAISY_API_TOKEN" \
  "$DAISY_API_BASE/maintainer/software"

Public read endpoints

MethodPathDescription
GET/softwarePublished software list
GET/software/{slug}Software details, images, links and maintainers
GET/software/{slug}/versionsVersions, platforms, sizes and SHA-256
GET/downloadsAll downloadable artifacts
POST/download-linksIssue a signed download link

Maintainer endpoints

MethodPathScopeDescription
GET/maintainer/softwaresoftware:readSoftware assigned to the current user
GET/maintainer/software/{slug}software:readFull software, media and artifact data
PATCH/maintainer/software/{slug}software:writeUpdate software information
PUT/maintainer/software/{slug}/beamlinessoftware:writeReplace applicable beamlines
POST/maintainer/software/{slug}/mediamedia:writeUpload covers, screenshots or manuals
POST/maintainer/software/{slug}/artifactsartifact:writeUpload an artifact
PATCH/maintainer/artifacts/{id}artifact:writeUpdate artifact metadata
POST/maintainer/artifacts/{id}/yankartifact:writeYank an artifact

Python example

No token is required for list/get. Only update requires a Bearer token. All actions use POST JSON on /maintainer/action.

# 获取
curl -X POST https://<site-domain>/api/v1/maintainer/action \
  -H "Content-Type: application/json" \
  -d '{"action":"get","slug":"daisy-xrs"}'

# 修改
curl -X POST https://<site-domain>/api/v1/maintainer/action \
  -H "Authorization: Bearer daisy_xxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "action":"update",
    "slug":"daisy-xrs",
    "fields":{"summary_zh":"新的软件简介"}
  }'

# 需要下载物或媒体时显式开启
curl -X POST https://<site-domain>/api/v1/maintainer/action \
  -H "Content-Type: application/json" \
  -d '{
    "action":"get",
    "slug":"daisy-xrs",
    "include_artifacts":true,
    "include_media":true
  }'

Optional: view the Python SDK ↗|Full API reference ↗

Need to inspect available software? software catalogue.