Newsman – Knowledge Base
Newsman Api Method: integration.getIntegrationMapping
Prototype: integration.getIntegrationMapping(integration)
Description: Returns the mapping (allowed settings) for an integration
HTTP method: GET
Endpoint HTTP: /integration.getIntegrationMapping.json
Endpoint XML-RPC: integration.getIntegrationMapping
Return type: struct
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| integration | string | The integration for which to fetch the mapping |
Response parameters
| Parameter | Description |
|---|---|
| settings | Key / value array of allowed settings (as keys) and the expected value type |
| required_settings | Array containing the minimum required settings |
| credentials | Array containing the allowed credentials |
| required_credentials | Array containing the required credentials |
| features | Array containing the available features (as keys) and the required settings for each |
Request examples
Output example
{ "settings": { "api_url": { "type": "uri", "required": true }, "api_key": { "type": "string", "required": true }, "plugin_version": { "type": "string", "required": true }, "platform_version": { "type": "string", "required": false }, "platform_server_ip": { "type": "ip", "required": false }, "platform_language": { "type": "string", "required": false }, "platform_language_version": { "type": "string", "required": false } } }
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param integration | integration param is required |
| 18001 | Invalid integration | Integration is not available |
Error examples
{ "err": true, "message": "Missing required param integration", "code": 407 }
{ "err": true, "message": "Invalid integration", "code": 18001 }