Personal Integration

When a client requests a personal integration, we have to do the following:
(Note: We have a macro in Zendesk that will write up all the requirements for you under Integration > Personal Integration [EN or AR]). You may combine Step 1 and 2 at the same time if the client did not share the account number initially.

Step 1: Account Type Verification:

We need to verify first the account type that client has:

• Agents must check via Foodics Accounts if the account is advanced or not. If not advanced, the agent must check further in CRM if the API license was purchased. 

• If the account is Advanced (Or API License is Purchased), proceed with Step 2

• If the account is NOT Advanced or has API license: Escalate the ticket with the Expansion team informing them that the client is aiming to get a personal integration and requires API License.

• Once the Expansion team provides the license to the customer, they can reach out to move on to step 2.
  
  

Step 2: Obtaining Requirements:

• Explain that Foodics is a cloud POS that supports integrations through RESTful APIs.

• Clearly explain that it’s the client’s responsibility to find a technical team who will be responsible for building the integration and Foodics will provide full support to assist the team in building the integration.

• Share Foodics API / Developer documents website.

• Ask the client to share his Foodics account number. 

• Ask the client to share the Application Name in which the client is planning to integrate with Foodics.

• Ask the client to share the Scope of Integration. (Technical or non-technical).

• Confirmation from the account’s owner email as registered in Foodics. (Request email has to be sent by Owner or the Owner approval is a CC in the email chain. Separate email with owner’s approval will NOT be accepted)

Step 3: Final things to check before Escalations
Support Agent should make sure that the requested application name is not already integrated with Foodics by checking Foodics Marketplace:

• Application is not present in Foodics Marketplace proceed to step E.

• Application is present in Foodics Marketplace: Inform the client that the requested application is already integrated with Foodics and share the integration's user guide from Foodics knowledge base and ask the client to connect with his Account Manager or the requested application’s support to assist in enabling the integration.

All personal token prerequisites should be listed the side ticket and following the template below:

Original thread link:
Account Number:
Account Type:
Owner Verification:
Application Name:
Scopes:

عزيزنا ,
تحية طيبة.

 

تتيح فودكس التكامل مع البرامج الخارجية الغير متاحة في متجر التطبيقات الخاص بفودكس عبر ال API.
مع ملاحظة ان برمجة التكامل تكون مسؤولية العميل اوفريق التطوير من البرنامج الاخر, وسيقوم فريق التكامل الخاص بفودكس بتقديم المساعدة اللازمة والاجابة عن استفسارتكم.

يرجى الاطلاع على مستندات التكامل عبر الروابط التالية: 

https://apidocs.foodics.com/

https://developers.foodics.com/

للبدأ في عملية التكامل, يرجى تزويدنا بالتالي

- رقم الحساب الخاص بك.

- اسم التطبيق الذي ترغب في التكامل معه
- تحديد نطاق الربط المطلوب (بامكان فريقك التقني او البرنامج الآخر تحديده) https://apidocs.foodics.com/core/scopes.html

 

ملاحظات:
- يجب أن تكون مالك الحساب لتقديم الطلب, في حال لم تكن, يرجى اضافة ايميل المالك الى المحادثة ومشاركة موافقته للاستمرار في العملية.
- رمز التكامل (API Token) يكون على مستوى الحساب كامل ولا يمكن تحديده لفروع محدده فقط، ولكن بالامكان تصفيه البيانات حسب الفرع عند استعمال التكامل.

أطيب التحيات,

فريق الدعم الفني

Dear ,

Hope this email finds you well.

To proceed with the integration, please share with us the following: 

1. Your Foodics account number

2. Please share the application name that you are integrating with. 

3. Please explain the integration scope, your technical team should do that. You can list the API scopes that you will need in your integration ( https://apidocs.foodics.com/core/scopes.html )

4. The request to get access must be coming from the business owner. If you are not the owner, you can add the owner email to this thread and ask him/her for confirmation on access. The owner confirmation will entail that Foodics will not be held responsible for any data corruption caused by the token’s write access if present.

To know who is the owner, log in to Console > Manage > Users, there will be one user with Role (Owner). we need confirmation from that email.

Please note that Foodics supports integration with the unlisted apps on Foodics Marketplace via RESTFul APIs.

You can find Foodics API Documentation at:

1. https://developers.foodics.com

2. https://apidocs.foodics.com

Note:
- The client or the third-party application will be responsible for the integration development, and Foodics Integration team will provide assistance if needed.

- The API token is on the account level which means can not be restricted to specific branches, however, it's possible to filter the branches when calling the endpoints.

Best Regards
Technical Support Team