API documentation

  1. API documentation for integration with iPress

[GET] Organizations > News
API version 1.0

Overview

This API returns all the datas on iPress related to a specific brand news.

All organizations API:

Request Link

GET: https://api.ipresslive.it/v1.0/organizations/news/read/

Request Parameters

Name Description Required
token APIKEY (40-character alphanumeric string) that allows access to the API. Yes
lng Language in which the results will be returned.
Default value: IT
Possible values:
  • IT: Italian
  • EN: English
  • DE: German
 No
id Id of the requested element to get a single result No
limit Number of shown results
With limit=n only n elements will be shown.
(Example: limit=7 will show only 7 or fewer elements) 		No

Request Example

GET: https://api.ipresslive.it/v1.0/organizations/news/read/?token={YOUR_APIKEY}&lng={LANGUAGE_CODE}&id={ID}&limit={LIMIT_NUMBER}

Response Elements

Name Description Type
Organization Organization name String
Id Id of the news Int
Title Title of the news String
ShortDescription Short description of the news String
FullDescription Full description of the news String
Date Date of the news Date (yyyy-mm-dd hh:mm:ss)
Signature Signature of the news author String
Link Link of the news String
Images List of news images of the brand.
  • Small: small version of the image (Type: string)
  • Medium: medium version of the image (Type: string)
  • Large: large version of the image (Type: string)
  • Caption: caption of the image (Type: string)
 Array
Videos List of news videos of the brand.
  • Link: link of the video (Type: string)
  • Caption: caption of the video (Type: string)
 Array
Attachments List of news attachments of the brand.
  • Link: link of the attachment (Type: string)
  • Caption: caption of the attachment (Type: string)
 Array

Response Example

								
[
  {
    "Organization": "iPress Live",
    "Id": "00000",
    "Title": "Lorem impsum dolor sit",
    "ShortDescription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "FullDescription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque mattis vestibulum consectetur...",
    "Date": "2022-01-01 12:30:00",
    "Signature": "Lorem impsum dolor sit",
    "Link": "https://www.ipresslive.it/it/ipress/view/00000/",
    "Images": [
      {
        "Small": "https://s3.amazonaws.com/iprs/files/images/00000/file-name__S.jpg",
        "Medium": "https://s3.amazonaws.com/iprs/files/images/00000/file-name__M.jpg",
        "Large": "https://s3.amazonaws.com/iprs/files/images/00000/file-name__L.jpg",
        "Caption": "Lorem impsum dolor sit"
      },
      ...
    ],
    "Videos": [
      {
        "Link": "https://s3.amazonaws.com/iprs/files/images/00000/file-name__S.jpg",
        "Caption": "Lorem impsum dolor sit"
      },
      ...
    ],
    "Attachments": [
      {
        "Link": "https://s3.amazonaws.com/iprs/files/images/00000/file-name__S.jpg",
        "Caption": "Lorem impsum dolor sit"
      },
      ...
    ]
  },
  ...
]

Response Errors

Code Description
404 Not found: invalid request
401 Unauthorized: APIKEY entered invalid or no longer enabled

Response Errors Example

	
{
  "responseCode": "404",
  "responseMessage": "Not found"
}