External API Configurations

Overview

The External API Configurations menu displays all external API configurations used to integrate Moyee with third-party services, such as face recognition, identity verification, and others. This feature allows you to manage endpoints, headers, body templates, and API usage priority.

Page Navigation

The External API Configurations page is located within the Dashboard » Config Management menu.

Configuration List Display

The configuration list page shows a table with the following columns:

• No - Sequence number
• Config Name - Descriptive configuration name
• API Type - API type (e.g., enroll face, face verification)
• Base URL - Base URL for API requests
• Endpoint - Specific endpoint (path after base URL)
• Priority - Priority (smaller number = higher priority)
• Status - Active status (✔ = active)
• Actions - Action buttons (Edit, Delete)

Configuration Data

Here is an example of registered API configuration data:

Total Data: 1–2 of 2

Search Feature

A search column is available to easily find configurations by keyword.

How to use:

1. Click on the search column
2. Type the keyword you want to search for (based on config name, api type, or base url)
3. Search results will appear automatically

Display Options

Several options are available to customize the table display:

• Columns - Select which columns to display
• Filters - Filter data based on specific criteria (e.g., status, priority)
• Export - Export data to file formats (CSV, Excel, etc.)

Rows per page

At the bottom of the page, there is a setting for the number of rows per page:

• Rows per page: 10
• Total data: 1–2 of 2

Adding a New Configuration

To add a new API configuration, click the Create New Config button. You will be directed to the new configuration form page.

Create New Config Form

The new configuration form page displays a form for entering external API data.

Form Components:

Status Settings:

How to Fill the Form:

1. Config Name
   • Enter an easily identifiable name
   • Example: Enroll Face, NeoAPI Face Recognition
2. API Type
   • Enter the API type according to its function
   • Example: enroll face, face verification, attendance sync
3. Base URL
   • Enter the root URL of the external API
   • Example: https://fr.neoapi.id
4. Headers (JSON) (Optional)
   • Enter required headers in JSON format
   • Example:

     {
       "Authorization": "Bearer {token}",
       "Content-Type": "application/json"
     }
     

5. Request Body Template (JSON) (Optional)
   • Enter the request body template
   • Use null for values that will be dynamically filled by the system
   • Example:

     {
       "image": null,
       "user_id": null,
       "timestamp": "2026-02-20T10:00:00Z"
     }
     

6. Priority
   • Enter a priority number (smaller is higher priority)
   • Default: 1
   • If there are multiple configurations with the same API type, the system will try according to priority
7. Active Status
   • Check if you want this configuration to be immediately active
8. Click Create to save the new configuration
9. Click Cancel to cancel

Configuration Actions

On each configuration row, action buttons are available to manage the data.

Edit

To edit configuration data:

1. Click the Edit icon on the configuration row you want to edit
2. The edit form will open with pre-filled data
3. Modify the necessary information (config name, api type, base URL, headers, body template, priority, status)
4. Click Save to save the changes
5. Click Cancel to cancel

Delete

To delete a configuration:

1. Click the Delete icon on the configuration row you want to delete
2. Confirm the deletion in the dialog that appears
3. The configuration data will be permanently deleted

Usage Tips

1. Use descriptive configuration names - Makes identification easier, especially if there are many APIs with similar types.
2. Manage priority wisely - For the same API type, set priority so the system tries backup endpoints if the primary one fails.
3. Utilize body templates - Use null for fields that will be dynamically filled by the system, so the template can be reused.
4. Store headers securely - If using tokens or credentials, ensure they are stored securely and not exposed.
5. Test configurations - Before activating, perform testing to ensure endpoints and parameters work.
6. Temporarily deactivate - If an API is having issues, deactivate the configuration without deleting it so the system switches to the next priority.
7. Document changes - Record configuration changes for audit and troubleshooting purposes.

Example Body Template Usage

Enroll Face API

{
  "user_id": null,
  "face_image": null,
  "timestamp": null
}

{
  "user_id": null,
  "face_image": null,
  "threshold": 0.8
}

{
  "employee_id": null,
  "check_in_time": null,
  "location": null,
  "photo": null
}

## Next Steps

- [FCM Notification Templates](/config-management/fcm-notification-templates)
- [Users](/user-management/users)
- [Usergroup](/user-management/usergroup)
- [Setup Parameter](/project-setup/setup-parameter)
- [Mobile App Configuration](/mobile-app/configuration)