# BytePro

### Byte Integration Capabilities

| BytePro                         |                                                                                                                                                                                                                             |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| File Types Accepted             | <ul><li>FNMA 3.2 Pushed directly to LOS</li><li>MISMO 3.4 Pushed directly to LOS</li></ul>                                                                                                                                  |
| Hub to LOS Document Integration | Client-provided documents push to LOS                                                                                                                                                                                       |
| LOS to Hub Document Integration | Not supported at this time                                                                                                                                                                                                  |
| Loan Status Sync to Hub         | <ul><li>Loan Status syncs from LOS</li><li>Automatic updating</li></ul>                                                                                                                                                     |
| Custom Field Mapping            | Supported                                                                                                                                                                                                                   |
| Loan Officer Assignment         | <ul><li>Can be assigned in LOS based on LO Hub application link</li><li>Can be assigned in LOS based on application type, even if no LO assigned in Hub</li></ul>                                                           |
| Third Party Integration Support | <ul><li>Third Party Services can be ordered in Application Hub</li><li>Reference/Report ID can map to LOS</li><li>Report will push to LOS documents</li></ul>                                                               |
| Mapping to Loan Templates       | <ul><li>Mapping can be completed based on basic loan template type (Conventional, Construction, HELOC, etc.)</li><li>Mapping can be completed based on specific loan product (30 Year, 15 Year, ARM, Fixed, etc.)</li></ul> |
| Disclosure Delivery             | Not supported at this time                                                                                                                                                                                                  |

## **Setting Up ByteWeb for API Integration with Maxwell’s Point of Sale System**

This guide outlines the steps for configuring your ByteWeb environment to enable secure API integration with Maxwell’s platform. It is intended for Byte administrators and IT personnel responsible for managing LOS settings.

### **1. Prerequisite: ByteWeb Access**

Before proceeding with the API configuration, ensure that your organization is using the **ByteWeb** product. See the [Getting started with the API](https://support.bytesoftware.com/s/article/How-To-Get-Started-With-API) documentation if you need more detailed instructions. You can also contact Byte support if you have additional questions. &#x20;

* **Required Product**: *ByteWeb (BWE)*\
  \&#xNAN;*Do not use Byte Consumer Edition (BCE).*

Maxwell needs the url for ByteWeb along with the site name (the last portion of the url path), if applicable, to set up your organization in our point of sale.&#x20;

### **2. Create a Byte API User**

A dedicated service user must be created within Byte with the correct configuration to allow Maxwell’s POS to access the system via API.

* **Product License**: `BytePro Enterprise`
* **Account Type**: `Non-System Service Account`
* **Security Profile Settings**:
  * Must have **"Use API (Application Programming Interface)"** enabled
* Store the Username and Password as you will need to provide a Maxwell admin with those details in the next step.&#x20;

### **3. Provide Required Environment & User Details to Maxwell**

To complete the integration setup, you’ll need to supply Maxwell <help@himaxwell.com> with the following:

Provide Maxwell with:

* The **username**
* The **password**\
  (Credentials will be used within the Maxwell Customization Hub

| **Field**             | **Description**                                                                                       |
| --------------------- | ----------------------------------------------------------------------------------------------------- |
| **ByteWeb URL**       | The full URL to your ByteWeb site                                                                     |
| **Site Name**         | The last segment of the ByteWeb URL path (e.g., `BWE_XXXXX`)                                          |
| **Organization Code** | <p>Found in BytePro under:<br><code>Tools > Admin Tools > Security Manager > Organizations</code></p> |
| **API Username**      | See above                                                                                             |
| **API User Password** | See above                                                                                             |

### **4. Maxwell Credential Configuration**

Once the required credentials are received, a Maxwell administrator will:

* Validate the credentials using an authentication call via Postman
  * A successful **auth call** is sufficient for verification
* Enter the credentials into the **Maxwell Customization Hub**
* Apply Maxwell’s **universal API Authorization Key**&#x20;

### **5. Integration Testing & Customization Checks**

Initial Testing

Before using the API in production, Maxwell strongly recommends that you:

* Set up and connect to a **ByteWeb test environment**
* Push a few **test applications and documents** to confirm that:
  * Authentication works
  * Data flows correctly between platforms
  * Any custom data fields and forms integrated beyond standard 3.4 mismo fields are updating correctly&#x20;

### Helpful Byte Documentation

* [Getting started with the API](https://support.bytesoftware.com/s/article/How-To-Get-Started-With-API)
* [Postman collection and other development materials](https://support.bytesoftware.com/s/article/BytePro-API-Development-Materials)
* [Surface level information about Byte Hosted ByteWeb](https://support.bytesoftware.com/s/article/Byte-Hosted-Clients-ByteWeb-Implementation-Considerations-and-FAQ)
* [Surface level information about Self Host ByteWeb](https://support.bytesoftware.com/s/article/ByteWeb-Implementation-Considerations-and-FAQ)
* Alternative path to documentation when inside of BytePro: Help > BytePro Enterprise Admin Guide > Contents tab > Introduction to ByteWeb
* [Deep instructions on self hosted installation](https://support.bytesoftware.com/s/AdminGuide/index.html)
  * Most information in here is not applicable and likely to be overwhelming