सामग्री पर जाएँ
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