# mulesoft OpenWeatherMap Connector - Full Documentation --- product: OpenWeatherMap Connector version: 1.0 is-latest-version: true --- # OpenWeatherMap Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for OpenWeatherMap (OpenWeatherMap Connector) enables Mule applications to access the OpenWeatherMap API. For information about compatibility and fixed issues, refer to the OpenWeatherMap Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The OpenWeatherMap Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the OpenWeatherMap target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [OpenWeatherMap Connector Reference](https://docs.mulesoft.com/openweathermap-connector/latest/openweathermap-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: OpenWeatherMap Connector version: 1.0 is-latest-version: true --- # OpenWeatherMap Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config Default configuration. #### Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | The connection types to provide to this configuration. | x | ||
Name | String | ID used to reference this configuration. | x | |
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
apiKey | String | API key used to authenticate requests to the OpenWeatherMap API. | x | |
baseUri | String | Base URI for the OpenWeatherMap API endpoint. | x | |
TLS Configuration | Configures TLS. If using the HTTPS protocol, you must configure TLS. | |||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
lat | Number | Latitude coordinate of the location. | x | |
lon | Number | Longitude coordinate of the location. | x | |
units | Enumeration, one of:
| Temperature units for the response. | ||
lang | String | Language code for the response text. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
lat | Number | Latitude coordinate of the location. | x | |
lon | Number | Longitude coordinate of the location. | x | |
Unix Timestamp | Number | Timestamp (Unix time, UTC time zone). Data is available from January 1st, 1979 till 4 days ahead. | x | |
units | Enumeration, one of:
| Temperature units for the response. | ||
lang | String | Language code for the response text. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
lat | Number | Latitude coordinate of the location. | x | |
lon | Number | Longitude coordinate of the location. | x | |
units | Enumeration, one of:
| Temperature units for the response. | ||
lang | String | Language code for the response text. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols | String | Comma-separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | Comma-separated list of cipher suites enabled for this context. | ||
Trust Store | Configures the TLS truststore. | |||
Key Store | Configures the TLS keystore. | |||
Revocation Check | Configures a revocation checking mechanism. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the truststore. Mule resolves the path relative to the current classpath and file system. | ||
Password | String | Password used to protect the truststore. | ||
Type | String | Type of store. | ||
Algorithm | String | Encryption algorithm that the truststore uses. | ||
Insecure | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the keystore. Mule resolves the path relative to the current classpath and file system. | ||
Type | String | Type of store. | ||
Alias | String | Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. | ||
Key Password | String | Password used to protect the private key. | ||
Password | String | Password used to protect the keystore. | ||
Algorithm | String | Encryption algorithm that the keystore uses. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities | Boolean | Which elements to verify in the certificate chain:
Verify only the last element in the certificate chain.
Verify all elements in the certificate chain. | ||
Prefer Crls | Boolean | How to check certificate validity:
Check the Certification Revocation List (CRL) for certificate validity.
Use the Online Certificate Status Protocol (OCSP) to check certificate validity. | ||
No Fallback | Boolean | Whether to use the secondary method to check certificate validity:
Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.
Do not use the secondary method to check certificate validity. | ||
Soft Fail | Boolean | What to do if the revocation server can’t be reached or is busy:
Avoid verification failure.
Allow the verification to fail. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url | String | URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the CRL file. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | ||
Reconnection Strategy | Reconnection strategy to use. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If | ||
Count | Number | How many reconnection attempts the Mule app can make. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time | Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | ||
Time Unit | Enumeration, one of:
| Time unit for the Max Idle Time field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Source | Enumeration, one of:
| Error source type to map. | ||
Target | String | Target error type to map to. | x |