API Connect - Resident Portal Implementation

API Connect - Resident Portal Implementation

Assumptions:

  1. 3rd party vendor has been validated.

Implementation steps:

  1. Signed contract/agreement from the mutual customer(s).
    • Contract/agreement provides license and permission to share customer data with the 3rd party.
  2. Identify and populate 3rd party vendor/client details. This will allow the 3rd party vendor to verify connectivity to our environment.
    • This step is only required once per 3rd party vendor/client.
    • Populate CLIENT_AUTH_OBJ_OWNER.OAUTH_CLIENT_DETAILS.
  3. Identify and populate mutual customer details. Coordinate and communicate with the 3rd party vendor/client as this will enable access to community and customer information. We will also want to communicate to the mutual customer(s) since these steps involve user experience changes.
    • Populate CLIENT_AUTH_OBJ_OWNER.CLIENT_COMMUNITY_ACCESS.
    • Populate CLIENT_AUTH_OBJ_OWNER.CLIENT_CUSTOMER_ACCESS.
    • Update FC_OBJ_OWNER.COMMUNITIES table to API_CONNECT_LICENSED = 'Y'.
      • This step changes user experience via Backoffice so generally we want to communicate to the mutual customer(s) when this is completed.
        1. An email is required for new customers.
        2. A different message will appear upon saving of the new customer.
    • Review logs on tomcatintegrationprod01 for activity from 3rd party vendor/client related to enabled customer.
  4. IF USING OLD VERSION OF RESIDENT PORTAL - Confirm Resident Portal is properly enabled on FullCount side
Confirm API Connect - Resident Portal Licensed has been properly assigned in Tracker and Accounting (Debbie) is aware of activation.
    • Related Articles

    • API Connect - Resident Portal Employee FAQ

      What is API Connect - Resident Portal? API Connect - Resident Portal is a gateway for 3rd party vendor partners to access FullCount's resident information displayed on Resident Portal Our partners will be able to pull resident account balances and ...
    • API Connect - Resident Portal Customer FAQ

      API Connect - Resident Portal Customer FAQ What is API Connect - Resident Portal? API Connect - Resident Portal is FullCount's read-only API suite for sharing real-time meal and charge account balances and transactions. The data included is identical ...
    • API Connect/Customer Portal SSO Email Template

      API Connect/Customer Portal SSO Email Template Email Template: Subject: <Community Name> - FullCount <> <Partner> integration Body: Hi <Community Contact>/<Partner> team, We have enabled the <API Connect AND/OR Single-Sign-On> integration between ...
    • New Resident Portal Setup & Communication

      The creation of our new Resident Portal is to be completed by the Implementer/Support representative assigned to the task. This process no longer requres an additional task or scheduled deliverables from our development team. Below are the steps ...
    • Resident Portal Email Registration Process

      Intent: This document should only be used for defining the process and programatic approach used to implent an email registration process for known users. This article aims to outline the business logic decisions that were made, why, and how they ...