{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"4f4e0431-4c49-4d0c-b498-c8aff67d8ee8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"d5b4efeb-00fb-45a0-8f94-8b8c1a5d236f"}},{"type":"rule"},{"type":"paragraph","content":[{"text":"With the ","type":"text"},{"text":"HttpDataProvider","type":"text","marks":[{"type":"code"}]},{"text":" you can access arbitrarily configurable HTTP/HTTPS endpoints. In the simplest kind of configuration, you specify a destination address and then convert the resulting data into contacts. Since many services require authentication, the provider allows you to define a sequence of HTTP requests to fetch \"access tokens\" or other data and use it for further HTTP requests.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition to the ","type":"text"},{"text":"Mapping","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"SearchParameters","type":"text","marks":[{"type":"code"}]},{"text":" configuration, which all ","type":"text"},{"text":"DataProvider","type":"text","marks":[{"type":"code"}]},{"text":"s of the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://primesoft-group.atlassian.net/wiki/spaces/PDTEN/pages/71532545"}},{"text":" require, the ","type":"text"},{"text":"HttpDataProvider","type":"text","marks":[{"type":"code"}]},{"text":" can be configured via the ","type":"text"},{"text":"Option","type":"text","marks":[{"type":"code"}]},{"text":" element:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n ...\n \n ...\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Configuration","type":"text","marks":[{"type":"strong"}]},{"text":" In this part the sequence of HTTP requests is defined.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Secret","type":"text","marks":[{"type":"strong"}]},{"text":" To avoid plain text passwords in configurations, secrets can be added as ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":". At runtime the password is decrypted and can be used as a placeholder for ","type":"text"},{"text":"Requests","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step","type":"text","marks":[{"type":"strong"}]},{"text":" A step comprises a ","type":"text"},{"text":"Request","type":"text","marks":[{"type":"code"}]},{"text":" and a ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":". An unlimited number of steps can be defined. During each step ","type":"text"},{"text":"Properties","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Contacts","type":"text","marks":[{"type":"code"}]},{"text":" can be added to the result list.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Request","type":"text","marks":[{"type":"strong"}]},{"text":" This element is used to build the HTTP request.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Method","type":"text","marks":[{"type":"strong"}]},{"text":" (attribute) HTTP method to be used (","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":", ...)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Url","type":"text","marks":[{"type":"strong"}]},{"text":" (attribute) Target URL of the request. Placeholders can be used in the URL using this notation: ","type":"text"},{"text":"{Placeholder}","type":"text","marks":[{"type":"code"}]},{"text":". Placeholders are always URL-encoded.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Header","type":"text","marks":[{"type":"strong"}]},{"text":" Any number of HTTP headers can be specified. Placeholders can also be used via the ","type":"text"},{"text":"{Placeholder}","type":"text","marks":[{"type":"code"}]},{"text":" syntax.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Body","type":"text","marks":[{"type":"strong"}]},{"text":" A body can be defined. Placeholders can also be used via the ","type":"text"},{"text":"{Placeholder}","type":"text","marks":[{"type":"code"}]},{"text":" syntax. No encoding is done here.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FakeResponse","type":"text","marks":[{"type":"strong"}]},{"text":" To test an endpoint, the ","type":"text"},{"text":"FakeResponse","type":"text","marks":[{"type":"code"}]},{"text":" element can be used to define a configurable return value.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Response","type":"text","marks":[{"type":"strong"}]},{"text":" The ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":" can be used to access the HTTP response. A ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":" can either create one or more ","type":"text"},{"text":"Property","type":"text","marks":[{"type":"code"}]},{"text":" elements ","type":"text"},{"text":"or","type":"text","marks":[{"type":"strong"}]},{"text":" perform a data mapping.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Property","type":"text","marks":[{"type":"strong"}]},{"text":" This element can be used to retrieve a specific value from the HTTP response using a ","type":"text"},{"text":"JsonPath","type":"text","marks":[{"type":"code"}]},{"text":" or an ","type":"text"},{"text":"XPath","type":"text","marks":[{"type":"code"}]},{"text":". The value is then available via the ","type":"text"},{"text":"{Placeholder}","type":"text","marks":[{"type":"code"}]},{"text":" for further requests under the configured name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Data ","type":"text","marks":[{"type":"strong"}]},{"text":"The actual data is searched for via this element. A ","type":"text"},{"text":"JsonPath","type":"text","marks":[{"type":"code"}]},{"text":" or an ","type":"text"},{"text":"XPath","type":"text","marks":[{"type":"code"}]},{"text":" must be specified here. The data is then converted via the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://primesoft-group.atlassian.net/wiki/spaces/PDTEN/pages/61410858"}},{"text":" for the ","type":"text"},{"text":"Schema","type":"text","marks":[{"type":"code"}]},{"text":" of the ","type":"text"},{"text":"Object","type":"text","marks":[{"type":"code"}]},{"text":" / ","type":"text"},{"text":"ObjectCollection","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Example","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported