ساخت شرکت
حرفه‌ایکلید خواندن و نوشتندر پلن حرفه‌ای و سازمانی در دسترس است (بتا).
POSThttps://app.reshta.ir/api/v1/public…/public/companies
یک شرکت تازه در کسب‌وکار صاحب کلید می‌سازد و رویداد company.created را برای وب‌هوک‌های شما می‌فرستد. پاسخ همان رکورد است.
درخواست
curl https://app.reshta.ir/api/v1/public/companies \ -X POST \ -H "Authorization: Bearer $RESHTA_API_KEY" \ -H "Idempotency-Key: 7f3c2b1e-4a5d-4c6f-9e1a-2b3c4d5e6f70" \ -H "Content-Type: application/json" \ -d '{"name":"پوشاک نیلا","domain":"example.com"}'سرآیندها
AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).
Idempotency-Keystringالزامیشناسهٔ یکتای همین عملیات، مثلاً یک UUID تازه؛ تکرار با همان کلید چیزی را دوبار انجام نمی‌دهد.
Content-Typeapplication/jsonالزامیبدنه JSON با UTF-8 است.
پارامترهای بدنه
namestringالزامینام شرکت.
domainstring | nullاختیاریدامنهٔ وب‌سایت.
industrystring | nullاختیاریصنعت.
national_company_idstring | nullاختیاریشناسهٔ ملی شرکت.
economic_codestring | nullاختیاریکد اقتصادی.
registration_nostring | nullاختیاریشمارهٔ ثبت.
owner_iduuid | nullاختیاریفقط رکوردهای این همکار.
customobjectاختیاریپیش‌فرض: {}فیلدهای سفارشی، با کلید هر فیلد.
پاسخ‌ها و خطاها
201—ساخته شد؛ بدنه همان رکورد است.
400validation_errorبدنه نادرست است یا Idempotency-Key نیامده؛ details می‌گوید کدام فیلد.
401unauthorizedکلید نیست، نادرست یا باطل است، یا سازنده‌اش دیگر فعال نیست.
403forbiddenکلید دسترسی نوشتن ندارد.
409conflictهمین Idempotency-Key با بدنهٔ دیگری آمده یا هنوز در جریان است.
429rate_limitedبیش از ۱۲۰ درخواست در دقیقه؛ Retry-After می‌گوید چند ثانیه صبر کنید.
پاسخ
400
{ "error": { "code": "validation_error", "message": "Idempotency-Key header is required", "details": [ { "field": "idempotency_key", "message": "idempotency_key_required" } ] }}وب‌هوک مرتبط: company.created