Settings Reference

Complete reference of all API Mapper settings

Settings Reference

Complete reference of all configuration options in API Mapper.

Global Settings

License

  • License Key: Your API Mapper license key
  • Status: Shows current license status and tier

Defaults

  • Default Cache Duration: Default cache time for new connections (in seconds)
  • Debug Mode: Enable verbose logging for troubleshooting

Connection Settings

Basic Settings

SettingDescriptionRequired
NameDisplay name for the connectionYes
Base URLRoot URL of the APIYes
DescriptionNotes about the connectionNo
EnabledWhether the connection is activeYes

Request Settings

SettingDescriptionDefault
EndpointPath to the API resource-
MethodHTTP method (GET, POST, etc.)GET
TimeoutRequest timeout in seconds30

Query Parameters

Add URL parameters that will be appended to requests:

FieldDescription
NameParameter name
ValueParameter value

Example: ?per_page=10&status=active

Headers

Custom HTTP headers to send with requests:

FieldDescription
NameHeader name
ValueHeader value

Example: Accept: application/json

Authentication

TypeFieldsUse Case
None-Public APIs
API KeyLocation, Name, KeyMost APIs
Bearer TokenTokenOAuth2, JWT
Basic AuthUsername, PasswordLegacy APIs

Field Mapping

SettingDescription
NameDisplay name in YOOtheme
PathJSON path to the data
TypeData type (Text, Number, etc.)

Available Types:

  • text - String values
  • number - Numeric values
  • image - Image URLs
  • link - Hyperlinks
  • date - Date/time values
  • boolean - True/false values

Caching

SettingDescriptionDefault
Enable CacheWhether to cache responsesYes
Cache DurationTime to cache in seconds3600
Cache KeyCustom cache identifierAuto

PHP Constants

WordPress

Override settings via wp-config.php:

// Disable caching globally
define('API_MAPPER_DISABLE_CACHE', true);
 
// Set default timeout
define('API_MAPPER_DEFAULT_TIMEOUT', 60);
 
// Enable debug mode
define('API_MAPPER_DEBUG', true);

Hooks & Events

WordPress

Filters

// Modify request before sending
add_filter('api_mapper_request', function($request, $connection) {
    // Modify $request
    return $request;
}, 10, 2);
 
// Modify response after receiving
add_filter('api_mapper_response', function($response, $connection) {
    // Modify $response
    return $response;
}, 10, 2);
 
// Modify cache duration
add_filter('api_mapper_cache_duration', function($duration, $connection) {
    return $duration;
}, 10, 2);

Actions

// After successful request
do_action('api_mapper_after_request', $response, $connection);
 
// On request error
do_action('api_mapper_request_error', $error, $connection);
 
// When cache is cleared
do_action('api_mapper_cache_cleared', $connection_id);

Environment Variables

For containerized deployments:

API_MAPPER_LICENSE_KEY=your-license-key
API_MAPPER_DEBUG=false
API_MAPPER_CACHE_DRIVER=redis

File Locations

WordPress
  • Settings: wp_options table (api_mapper_settings)
  • Connections: wp_options table (api_mapper_connections)
  • Cache: WordPress Transients API

Was this page helpful?

On this page