Base

The Base component contains the common settings of the app that are inherited by all modules.

The common settings include:

• Base URL: The API base URL used as the main address for all requests to the API.

• Authorization: Authentication information and credentials.

• Error Handling and Sanitization: Same as the Connections component.

If a module doesn’t define a setting, it follows what’s in the Base. However, if a module specifies a different value for the same setting, for example a different error handling directive, this overrides what's present in the Base.

The Base component is the code where you specify the common directives and the common data if needed. When you create a new app, the Base is filled in with default code.

Set up Base for your Geocodify custom app

To set up the Base for your custom app:

1

Remove the default code that is present.

2

Copy and paste the following code:

{
	// Default request configuration
	"baseUrl": "https://api.geocodify.com/v2", // Default base URL for all modules and RPCs.
	"qs": { // Default query parameters for all modules.
		"api_key": "{{connection.apiKey}}" // API key, which user will provide in the connection as parameter.
	},

	// Default response handling
	"response": {
		"error": { // Error handling
			"message": "[{{body.meta.code}}] {{body.meta.error_detail}}" // On error, returns error detail
		}
	},

	"log": {
		"sanitize": [ // Excludes sensitive parameters from logs.
			"request.qs.api_key" // remove api_key query param from logs.
		]
	}
}

Code	Description
"baseUrl": "https://api.geocodify.com/v2",	Contains the base URL of the API. Note that it contains the API version.
"api_key": "{{connection.apiKey}}"	Contains the query parameter for authentication. Note that the apiKey parameter is taken from the Connections component and accessed using connecotin.apiKey.
"response": { "error": { // Error handling "message": "[{{body.meta.code}}] {{body.meta.error_detail}}" } },	Instructions on how to handle errors. Note that in this case the code is the same as in the Connections component.
"log": { "sanitize": [ "request.qs.api_key" ] }	Instructions on the information that is saved in the logs. sanitize specifies what needs to be omitted. Note that in this case the code is the same as in the Connections component.

3

Click Save changes.

Continue to set up the module.