الانتقال إلى المحتوى
PaxHelm

واجهة PaxHelm البرمجية. بياناتك في متناولك.

مهام مساحتك ومشاريعها وملاحظاتها وتذكيراتها ومتابعاتها وأشخاصها عبر HTTPS وبتنسيق JSON، بالصلاحيات نفسها التي لديك في التطبيق. لا يُحذف أي شيء عبر الواجهة البرمجية.

مستند 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 كيلوبايت.

نقاط النهاية

أوصاف نقاط النهاية باللغة الإنجليزية، مثل مستند 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