Create first form

In order to perform updates to your ninox database, Ninoxbee needs a few information so that all its interactions with your ninox instance is bound to the context of that database.

Ninoxbee allows you to define a few other extra skinning variables. The code block below shows all the possible values for the form creation api call to ninoxbee.

function saveOrUpdateForm(form:Form) do
	let _ninoxHost := "anastasia.ninoxdb.com";
	let _ninoxApiKey := "YOUR_NINOX_API_KEY";
	let _captchaProtect := false;
	let _teamId := teamId();
	let _databaseId := databaseId();
	let _askUntilDate := date(2024,1,1);
	let _startAcceptingDate := today();
	let _ninoxbeeHost := "https://app.ninoxbee.com";	
	let _body := {
			host: _ninoxHost,
			apiKey: _ninoxApiKey,
			teamId: _teamId,
			databaseId: _databaseId,
			introFn: "_myIntroFn",
			initFn: "_myInitSessionFn",
			summaryFn: "_myGetSummary",			
			nextFn: "_myGetNextQuestionFn",
			prevFn: "_myGetPreviousQuestionFn",
			answerFn: "_myAnswerQuestionFn",
			buttonTextFn: "_myButtonTextFn",
			captcha: _captchaProtect,
			pinCode: "" + a.'Pin Code',
			askUntil: "" + format(_askUntilDate, "YYYY-MM-DD"),
			enabled: true,
			startDate: "" + format(_startAcceptingDate, "YYYY-MM-DD"),
			introImgUrl: "URL TO A PUBLIC IMAGE TO DISPAY ON INTRO SCREEN",
			basicSkinning: {
				logoUrl: "URL TO FORM LOGO,
				headerTitle: "TITLE OF THE FORM IN HEADER",
				headerBgColor: "#000000",
				headerFgColor: "#FFFFFF"
			},
			languages: [{
					code: "fr",
					name: "Français",
					languageOrder: 1
				}],
			advancedSkinning: null,
			formExpiredMessage: "This form has expired,
			pincodeErrorMessage: "Invalid pincode",
			formNotOpenYetMessage: "Form not open",
			formNotPublishedMessage: "For not published"
		};
	if form._FORM_ID = null then
		let response := do as server
				http("POST", _ninoxbeeHost + "/api/v1/forms", {
					'x-auth': "_YOUR_NINOXBEE_APIKEY",
					'content-type': "application/json"
				}, _body)
			end;
		a.(_FORM_ID := response.result.result.uuid);
		a.(_FORM_URL := response.result.result.publicUrl)
	else
		let response := do as server
				http("PUT", nbHost() + "/api/v1/forms/" + a._FORM_ID, {
					'x-auth': s.'Ninoxbee Api Key',
					'content-type': "application/json"
				}, _body)
			end;
		void
	end
end;

introFn and initFn

This function is responsible of rendering the first card or the landing screen card. It is displayed after the captcha protection.

function introFn(form_id : text,language : text) do
	{
		title: "Title for your form based on form_id and language",
		description: "Intro text based for _form_id and language"
	}
end

When this function is invoked by ninoxBee, a card shows on ninoxbee portal displaying the title and the description as well as a start button. Hitting the start button invokes a call on ninox which generates a session object in which all future interactions will be attached.

function initSession(_formId : text) do
	{
		submissionId: "5bb24177-8d80-4c11-b5bf-7d103f49a319"
	}
end;

The submissionId returned above should be generated by your ninox database. It will be submitted by ninoxbee automatically for all the remaining calls. Using this submissionId you should be able to identify which user is attached to this form and submit the answers to the correct record.

Ninoxbee ninox app

Open the downloaded Ninoxbee app from your workspace, and start configuring your API Key. The API key can be found in your Ninoxbee Portal.

One you've registered your key, click on the key line. The app will automatically retrieve all active forms for that Api-key.

In the Key view, you can preview the attached forms and Manage your Stripe subscription page.

A form in Ninoxbee is a scafolding object for generating forms dynamically from your Ninox database. Give your form a title and hit Save. Ninoxbee assigns you a unique ID and a URL to access that form.

At this stage of the process your form is still not accessible; clicking on the generated link should return you a "The form is not published yet" error page.

Ninoxbee features an Intro view securely hosted within its configuration. For enhanced security, API calls to your Ninox database are initiated only after successful completion of the captcha challenge on your form.

Required

Now that you've configured your forms let's take a look at the 4 main function you need to implement in your app to interact with this form.