راه‌اندازی سریع

ساخت یوزر فینووی

پس از اینکه در سایت hubinno.ir ثبت‌نام کردید و توکن خود را ساختید (راهنمای دریافت توکن از سایت هابینــو)، باید برای شروع کار با فینووی یک یوزر داشته باشید. یوزر فینووی را با دستور زیر می‌توانید بسازید. توکن hubinno-key خود را باید در هدر درخواست قرار دهید. از securityQuestion و securityAnswer برای بازیابی کلمه عبور استفاده می‌شود. لطفاً آن را با دقت تکمیل کنید.

جهت مشاهده ویدئو آموزشی «ساخت یوزر فینووی» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/users/root' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"email": "email",
	"password": "password",
	"phone": "phone",
	"securityQuestion":"any_question",
	"securityAnswer":"any_answer"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:14:45 GMT

دریافت توکن فینووی

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

جهت مشاهده ویدئو آموزشی «دریافت توکن فینووی» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/users/login' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"password": "password",
	"email": "email"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 200
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:14:45 GMT

Body:
fcba12ec-b230-41cd-ab18-xxxxxx

ساخت تننت

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

جهت مشاهده ویدئو آموزشی «ساخت تننت» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/tenants' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"name": "test",
	"description": "description about this tenant"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:19:00 GMT

Body:
e206a499-3220-4c84-8057-xxxxxx

آپلود کاتالوگ برای هر تننت

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

جهت مشاهده ویدئو آموزشی «آپلود کاتالوگ برای هر تننت» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https: //api.hubinno.ir/finnoway/0.3/catalogs/committed' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"tenantId": "tenant_id",
	"catalog": {
		"date": "2019-01-01T00:02:02.123Z",
		"billingType": "BEFORE",
		"currencies": [
			"IRR"
		],
		"products": [
			{
				"name": "Membership",
				"type": "BASE"
			}
		],
		"plans": [
			{
				"name": "One-Month-Membership",
				"product": "Membership",
				"finalStep": {
					"type": "EVERGREEN",
					"timeLength": {
						"timeUnit": "UNLIMITED"
					},
					"recurring": {
						"billingCycle": "MONTHLY",
						"recurringPrice": {
							"prices": [
								{
									"currency": "IRR",
									"value": 350000
								}
							]
						}
					}
				}
			}
		],
		"planLists": {
			"default": {
				"name": "DEFAULT",
				"plans": [
					"One-Month-Membership"
				]
			}
		}
	}
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:14:45 GMT

ساخت اکانت و ولت مشتری و یا تأمین‌کننده

در این مرحله می‌توانید به ازای هر مشتری یا تأمین‌کننده و یا هر موجودیت دیگری که با شما تعامل مالی دارد، یک اکانت بسازید. شما می‌توانید در زمان ساخت اکانت، ارز یا ارزهای مورد نظر مشتری را برای استفاده در کیف پول او انتخاب کنید. یکی دیگر از قابلیت‌های جذاب فینووی در این بخش، مشخص کردن روز صدور صورتحساب به ازای هر مشتری می‌باشد. برای مثال مشتری A اول هر ماه را برای صدور صورتحساب‌های مربوط به خود مناسب می‌داند و مشتری B دهم هر ماه را برای صدور صورتحساب‌های خود انتخاب می‌کند. انتخاب تایم زون و بسیاری از موارد دیگر به ازای هر مشتری از دیگر قابلیت‌های فینووی محسوب می‌شوند.

جهت مشاهده ویدئو آموزشی «ساخت اکانت و ولت مشتری و یا تأمین‌کننده» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/accounts' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"address": "Beheshti st",
	"city": "TEHRAN",
	"company": "Finnoway",
	"country": "IRAN",
	"currency": "IRR",
	"email": "email",
	"name": "finnoway",
	"description": "most powerful billing service",
	"phone": "021-91010227",
	"timeZone": "UTC",
	"username": "finnoway",
	"billingDay": 1
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:19:00 GMT

Body:
e206a499-3220-4c84-8057-xxxxxxxx

ایجاد اشتراک در برنامه‌های فروش

پس از طراحی و پیاده‌سازی برنامه‌های فروش از طریق آپلود کاتالوگ و در ادامه‌ی ساخت اکانت به ازای هر یک از مشتریان، وقت آن است تا مشخص کنیم که هر یک از مشتریان کدام یک از برنامه‌های فروش را خریداری کرده‌اند تا «فینووی» بر همین اساس، صورتحساب‌های مربوطه را در زمان‌های مقرر برای آن‌ها صادر کند. توجه داشته باشید که مشتریان شما هیچکدام با سایت «فینووی» در ارتباط نیستند و کلیه فرایندهای مربوط به صدور صورتحساب، پرداخت و … همگی ما بین فینووی و سایت یا اپلیکیشن شما اتفاق می‌اُفتد.

جهت مشاهده ویدئو آموزشی «ایجاد اشتراک در برنامه‌های فروش» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/subscriptions' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"planName": "plan1",
	"tenantId": "tenant1",
	"accountId": "account1",
	"description": "description about this subscription"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:19:00 GMT

Body:
e206a499-3220-4c84-8057-xxxxxxx

ثبت مصرف مشتری

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

جهت مشاهده ویدئو آموزشی «ثبت مصرف مشتری» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/usages/record' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"amount": "100",
	"date": "2021-03-14",
	"subscriptionId": "sub1",
	"unit": "unit1"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:19:00 GMT

دریافت صورتحساب و پرداخت آن

بر اساس نوتیفیکیشن‌هایی که از «فینووی» دریافت می‌کنید، می‌توانید در زمان‌های مورد نظر خود، صورتحساب صادر شده برای مشتریان را از فینووی دریافت کرده و به آن‌ها نمایش دهید. پس از پرداخت صورت‌حساب‌ها توسط مشتریان، باید اطلاعات پرداخت را در فینووی ثبت کنید.

جهت مشاهده ویدئو آموزشی «دریافت صورتحساب و پرداخت آن» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.

				
					curl --location --request GET 'https://api.hubinno.ir/finnoway/0.3/invoices/by-account/pagination?accountId=id&page=1' \
--header 'finnoway-access-token: aaaaa' \
--header 'hubinno-key: xxxxx'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 200
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 30 Mar 2021 11:24:34 GMT

{
"total": 1,
"list": [
	{
		"recordId": 388xxxx,
		"id": "26ce4e0e-7ca9-489d-81a9-e2xxxxxx",
		"amount": 350000.00,
		"currency": "IRR",
		"refundedAmount": 0.00,
		"invoiceDate": "2021-03-30",
		"targetDate": "2021-03-30",
		"balance": 350000.00,
		"accountId": "db2f2b12-6cbb-4fcc-8fd8-c2xxxxxxx",
		"tenantId": "9837a124-b12c-4b4d-9ca6-0f3xxxxxxx",
		"paymentStatus": "UNPAID",
		"items": null,
		"type": "SUBSCRIPTION",
		"status": "COMMITTED",
		"linkedInvoiceId": null
	}]
}

از دستور زیر برای ثبت اطلاعات پرداخت صورتحساب‌ها استفاده کنید.

				
					curl --location --request POST 'https://api.hubinno.ir/finnoway/0.3/payments/trigger' \
--header 'finnoway-access-token: aaaaa' \
--header 'Content-Type: application/json' \
--header 'hubinno-key: xxxxx' \
--data-raw '{
	"amount": "40000",
	"invoiceId": "invoice1",
	"description": "description about this payment"
}'

پاسخ به شکل زیر خواهد بود:

				
					HTTP/1.1 201
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Tue, 30 Mar 2021 11:19:00 GMT

Body:
e206a499-3220-4c84-8057-xxxxxx

دریافت نوتیفیکیشن‌ها

جهت مشاهده ویدئو آموزشی «دریافت نوتیفیکیشن‌ها» و مطالعه کامل‌تر مستندات این بخش، کلیک کنید.