본문으로 건너뛰기
PaxHelm

PaxHelm API. 내 데이터를 손닿는 곳에.

워크스페이스의 작업, 프로젝트, 메모, 리마인더, 후속 조치, 사람을 HTTPS와 JSON으로, 앱에서와 같은 권한으로 다룹니다. API로는 아무것도 삭제되지 않습니다.

OpenAPI 3.1 문서토큰 만들기

인증

설정 › 보안 › API에서 개인 토큰을 만들고 모든 요청에 함께 보내세요: Authorization: Bearer pxa_…. 토큰은 한 번만 표시되며, 만료일을 둘 수 있고 언제든 취소할 수 있습니다. 범위: pdash.read, pdash.write.

curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=open

목록, 버전, 한도

목록은 최신순으로 페이지 단위로 옵니다. 변경할 때마다 읽은 expectedVersion을 보내며, 그사이 레코드가 바뀌었으면 409를 반환합니다. 토큰당 분당 최대 120건, 본문은 최대 64 KB입니다.

엔드포인트

엔드포인트 설명은 OpenAPI 문서와 마찬가지로 영어로 되어 있습니다.

메서드경로범위하는 일
GET/api/v1/taskspdash.readList tasks, newest first
POST/api/v1/taskspdash.writeCreate a task
GET/api/v1/tasks/{id}pdash.readGet one task
PATCH/api/v1/tasks/{id}pdash.writeChange a task (send only the fields to change, with expectedVersion)
POST/api/v1/tasks/{id}/completepdash.writeComplete a task
POST/api/v1/tasks/{id}/reopenpdash.writeReopen a task
GET/api/v1/projectspdash.readList projects, newest first
POST/api/v1/projectspdash.writeCreate a project
GET/api/v1/projects/{id}pdash.readGet one project
PATCH/api/v1/projects/{id}pdash.writeChange a project (send only the fields to change, with expectedVersion)
GET/api/v1/notespdash.readList notes, newest first
POST/api/v1/notespdash.writeCreate a note
GET/api/v1/notes/{id}pdash.readGet one note
PATCH/api/v1/notes/{id}pdash.writeChange a note (send only the fields to change, with expectedVersion)
GET/api/v1/reminderspdash.readList reminders, newest first
POST/api/v1/reminderspdash.writeCreate a reminder
GET/api/v1/reminders/{id}pdash.readGet one reminder
PATCH/api/v1/reminders/{id}pdash.writeChange a reminder (send only the fields to change, with expectedVersion)
POST/api/v1/reminders/{id}/completepdash.writeComplete a reminder
POST/api/v1/reminders/{id}/snoozepdash.writeSnooze a reminder
GET/api/v1/follow-upspdash.readList follow-ups, newest first
POST/api/v1/follow-upspdash.writeCreate a follow-up
GET/api/v1/follow-ups/{id}pdash.readGet one follow-up
PATCH/api/v1/follow-ups/{id}pdash.writeChange a follow-up (send only the fields to change, with expectedVersion)
POST/api/v1/follow-ups/{id}/closepdash.writeClose a follow-up
GET/api/v1/peoplepdash.readList people, newest first
POST/api/v1/peoplepdash.writeCreate a person
GET/api/v1/people/{id}pdash.readGet one person
PATCH/api/v1/people/{id}pdash.writeChange a person (send only the fields to change, with expectedVersion)

웹훅

변경이 생기면 PaxHelm이 내 HTTPS 주소로 알립니다. 알림마다 HMAC-SHA256 서명이 붙고, 서버가 응답하지 않으면 다시 시도합니다. 이벤트:

  • task.created
  • task.updated
  • task.completed
  • project.created
  • project.updated
  • project.completed
  • note.created
  • note.updated
  • note.archived
  • reminder.created
  • reminder.updated
  • reminder.completed
  • follow_up.created
  • follow_up.updated
  • follow_up.closed