Newsman – Knowledge Base
Metoda API Newsman: integration.getIntegrationMapping
Prototip: integration.getIntegrationMapping(integration)
Descriere: Returnează mapping-ul (setări permise) pentru o integrare
Metoda HTTP: GET
Endpoint HTTP: /integration.getIntegrationMapping.json
Endpoint XML-RPC: integration.getIntegrationMapping
Tip raspuns: struct
Parametrii request GET
| Variabila | Tip | Descriere |
|---|---|---|
| integration | string | Integrarea pentru care să se preia mapping-ul |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| settings | Array cheie / valoare conținând setările permise (ca și chei) și tipurile de valori asțeptate |
Exemple request
Exemplu output
{ "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 } } }
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param integration | Parametrul integration este obligatoriu |
| 18001 | Invalid integration | Integrarea nu este disponibilă |
Exemple de erori
{ "err": true, "message": "Missing required param integration", "code": 407 }
{ "err": true, "message": "Invalid integration", "code": 18001 }