احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت می‌کند.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X POST https://api.zinndigital.com/v1/agency/time/rates \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "scope": <string<task, project, client, org>>, "amount_minor": <integer>, "currency": <string>, "effective_from": <string> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

amount_minor is the price of ONE HOUR for kind: hourly, and the price of the whole job for kind: fixed. ⛔ A fixed price is billed once for the task it is set on, however many hours are logged against it — the minutes are still recorded and reported, they simply do not each carry money. It is not "an hourly rate of zero".

بدنه درخواست

نامنوعالزامیچیست
scopestring<task, project, client, org>بله
scope_idstringخیر
kindstring<hourly, fixed>خیر
amount_minorintegerبله
currencystringبله
effective_fromstringبله
org_idstringخیر

پاسخ

نامنوعالزامیچیست
idstringبله
scopestring<task, project, client, org>بله
scope_idstringخیرThe task/project/client this applies to. null exactly when scope is org.
kindstring<hourly, fixed>بله
amount_minorintegerبلهMinor units. For hourly, the price of ONE HOUR — ⛔ never a price per minute, and never divided by 60 anywhere on this API.
currencystringبله
effective_fromstringبلهApplies to work done on or after this date. Resolution is against the work's date, never today, so a rate rise does not re-price last month.
archivedbooleanبله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422