Solutions
Services

Client Help Center

FAQ Clients Export, API and Connectors

Clients

Can greatcontent push texts against an external API?

Friday, June 26, 2020 8:39 AM

GC offers the option to push accepted texts with defined formatting and export structure to a connected API endpoint in JSON or XML format. In case other formats are required, custom solutions can be developed depending on your requirements.



Configuration options:


  • Connection
    • GCs system can connect to any defined endpoints based on a provided authentication method.

  • Endpoint requirements
    • Request method: POST
    • Response success code: 200 (In case of failure body of the Response will be stored as it is.)
  • Export triggers
    • Texts are pushed upon acceptance and by manual trigger in the GCs system. 
    • Each text can be accepted manually by the users or automatically after a number of days. 

  • HTML formatting
    • Texts will be formatted as valid HTML with UTF-8 encoding according to the defined layout requirements.
    • Number, order, and amount of formatting elements can be strictly defined and will be validated prior to text submission.
    • Example: 

      <h1></h1>
      <h2></h2>
      <h3></h3>
      <h4></h4>
      <h5></h5>
      <h6></h6>
      <p></p>
      <ul></ul>
      <ol></ol>


  • Export sections
    • Texts will be structured according to the defined layout requirements. Each export section can be exported as a separate block.
    • Example: 

      [[Export element 1]]
      <h1></h1>

      [[Export element 2]]
      <H2></H2>
      <p></p>
      <ul><li></li></ul>

      [[Export element 3]]
      <p></p>

      <p></p>
      <p></p>


  • Export formats
    • Each text has the following structural elements:
      • order_no (GC order number)
      • external_id (External client identifier)
      • keywords (Array with all keywords and number of occurrences in the order)
      • title (Title of the text)
      • text (Entire text including HTML formatting)
      • sections (Each text segment including HTML formatting as defined in export structure)
      • acceptedAt (Time of acceptance of the text in format: Year, Month, Data, Hour, Minute, Second, Timezone GMT+1 (Berlin))
      • updatedAt (Time of the last update of the text in format: Year, Month, Data, Hour, Minute, Second, Timezone GMT+1 (Berlin))
    • JSON example:

       {
       "order_no":
      "O3H6K82K4JU6",
       "external_id":
      "",
       "title":
      "Test JSON export",

       "keywords": ["Dahab Urlaub", "Hotel", "Reise"],
       "text":
      "<h1>lorem ipsum<\/h1>\n\n<h2>lorem ipsum<\/h2>\n\n<p>lorem ipsum<\/p>\n\n<ul>\n<li>lorem ipsum<\/li>\n\n<li>lorem ipsum<\/li>\n\n<li>lorem ipsum<\/li>\n\n<\/ul>\n\n<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum<\/p>\n\n<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u00a0 \u200blorem ipsum lorem ipsum\u200b lorem ipsum<\/p>\n\n<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum \u200b\u200blorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum \u200b lorem ipsum lorem ipsum\u200b lorem ipsum Test<\/p>\n\n",
      "sections": {
       "[[Export element 1]]":
      "<h1>lorem ipsum<\/h1>\n\n",
       "[[Export element 2]]":
      "<h2>lorem ipsum<\/h2>\n\n<p>lorem ipsum<\/p>\n\n<ul>\n<li>lorem ipsum<\/li>\n\n<li>lorem ipsum<\/li>\n\n<li>lorem ipsum<\/li>\n\n<\/ul>\n\n",
       "[[Export element 3]]":
      "<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum<\/p>\n\n<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum\u00a0 \u200blorem ipsum lorem ipsum\u200b lorem ipsum<\/p>\n\n<p>lorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum \u200b\u200blorem ipsum lorem ipsum\u200b lorem ipsum\u200b lorem ipsum lorem ipsum\u200b lorem ipsum \u200b lorem ipsum lorem ipsum\u200b lorem ipsum Test<\/p>\n\n"
              }

      "acceptedAt“: "2020-12-01 12:12:12",
             
      "updatedAt“: "2020-12-01 12:12:12"
      }