NAV
Shell HTTP JavaScript Ruby Python PHP Java Go

Agencia EFE Web Api

General Information

Version 1.0.0

Schemes https

Host & base path

https://apinews.efeservicios.com

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Overview

Introduction:
Through this API you can programmatically access your contracted content
The API allows you to receive continuous content feed as well as perform parameterized searches.

What types of content are available:
Content types including text, photo, audio, video, files ...
Each news item contains general information about the news item or package and a collection of objects that represent each item that makes up the information.

Changelog

We will list any changes to the current version of the API here.

Date Details of changes
2022-08-29 Created Endpoints for perform searches by ProductId, Format and IPTC Category
2021-10-04 Added formatIdentifier field to File objects to identify the format qualities
2020-10-15 Added the original content id in multimedia contents

Quick Start

To start using our API, you must contact the Agencia EFE commercial department to request your access credentials. It is recommended to first read the Introduction, this will give you an overview of some key concepts in use by the Agencia EFE Contents Api system.

Once you have your credentials and are familiar with the basic concepts you can start test our Api.

Information

Api Explorer / Open Api Specification

An interactive API Explorer is available in:

https://apinews.efeservicios.com

This is useful way to test API calls and the OAuth workflow. Check this video for the first steps:

Authentication

Agencia EFE Api uses the OAuth 2 protocol to provide authorization. OAuth is an authorization framework that enables third-party applications to obtain access to protected resources (Product subscriptions info, Contents, Consumes) in the Agencia EFE API. This section covers application authentication that is intended for server-to-server applications.

The client credentials flow is the simplest OAuth 2 grant, with a server-to-server exchange of your application’s client_id, client_secret for an OAuth application access token.

An authorization header containing a valid access token must be included in every Agencia EFE API request like follows:

Authorization: Bearer 5262d64b892e8d43410as3d01 The bearer token is your key to accessing all of your resources. Keep it safe.

SSL must be used in all Agencia EFE API interactions.

Account Endpoints Group

This endpoints groupoffers information and functionalities associated with your customer account.

GET /account/token (Token Acquisition??)

Code samples

# You can also use wget
curl -X GET /account/token?clientId={YourClientId}&clientSecret={YourSecret} \
  -H 'Accept: application/json' \


GET /account/token?clientId={YourClientId}&clientSecret={YourSecret} HTTP/1.1

Accept: application/json



const headers = {
  'Accept':'application/json',
  };

fetch('/account/token?clientId={YourClientId}&clientSecret={YourSecret}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
}

result = RestClient.get '/account/token?clientId={YourClientId}&clientSecret={YourSecret}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
}

r = requests.get('/account/token?clientId={YourClientId}&clientSecret={YourSecret}', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/account/token?clientId={YourClientId}&clientSecret={YourSecret}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/account/token?clientId={YourClientId}&clientSecret={YourSecret}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/account/token?clientId={YourClientId}&clientSecret={YourSecret}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /account/token

Obtaining an Access Token for your identification

Through this Endpoint you will obtain a valid Access Token for 24 hours.
This token must be attached in the Authorization header with the following format "Bearer {YourToken}"

URL Parameters

Name In Type Required Description
clientId query string false Customer identifier provided by Agencia EFE
clientSecret query string false Password or secret provided by Agencia EFE

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /account/products (Get Your Product information Endpoint??)

Code samples

# You can also use wget
curl -X GET /account/products \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /account/products HTTP/1.1

Accept: application/json
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'application/json',

  'Authorization':'Bearer [Bearer Token]'
};

fetch('/account/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',,
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/account/products',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',,
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/account/products', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/account/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/account/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/account/products", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /account/products

You obtain the information of the products to which you are subscribed as a customer

You will get a json/xml formatted with the information about the products you are subscribed to. You will use certain information, such as product identifiers, in the subsequent content purchase request.

You can use the lang_code with a supported value to get the literal stings in that language. For example: Depends on the value sent in lang_code, you can get "Today's News" or "Actualidad" in the description field of the classification.

URL Parameters

Name In Type Required Description
lang_code query string false Language code (ISO-XX)Admited values: ES / EN / AR / PT / CA .Default(if you dont use the parameter): ES
Authorization header string true JWT access token

Example responses

200 Response

{
  "httpResponse": {
    "code": 0,
    "status": "string"
  },
  "parameters": {
    "lang_code": "string",
    "client_id": 0,
    "id_Servicio": 0,
    "idPaquete": 0
  },
  "data": {
    "envelope": {
      "itemsCount": 0,
      "totalFound": 0
    },
    "products": [
      {
        "id": 0,
        "name": "string",
        "format": {
          "id": 0,
          "description": "string"
        },
        "classification": {
          "id": 0,
          "description": "string"
        }
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ProductResponse>
  <httpResponse>
    <code>0</code>
    <status>string</status>
  </httpResponse>
  <parameters>
    <lang_code>string</lang_code>
    <client_id>0</client_id>
    <id_Servicio>0</id_Servicio>
    <idPaquete>0</idPaquete>
  </parameters>
  <data>
    <envelope>
      <itemsCount>0</itemsCount>
      <totalFound>0</totalFound>
    </envelope>
    <products>
      <id>0</id>
      <name>string</name>
      <format>
        <id>0</id>
        <description>string</description>
      </format>
      <classification>
        <id>0</id>
        <description>string</description>
      </classification>
    </products>
  </data>
</ProductResponse>

Responses

Status Meaning Description Schema
200 OK Success ProductResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /account/consumption (Get your consumption information ?? )

Code samples

# You can also use wget
curl -X GET /account/consumption \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /account/consumption HTTP/1.1

Accept: application/json
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'application/json',

  'Authorization':'Bearer [Bearer Token]'
};

fetch('/account/consumption',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',,
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/account/consumption',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',,
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/account/consumption', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/account/consumption', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/account/consumption");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/account/consumption", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /account/consumption

Get your consume information.

Through this endpoint you can obtain information about your consumption

Get a list of requests made, response status and the total number of request for a period of time of your choice.

URL Parameters

Name In Type Required Description
date_from query string false Starting date: yyyyMMddThhmmss, NOW/DAY, NOW-24HOURS/HOUR, NOW-7DAYS/DAY, ...
date_to query string false Ending date: yyyyMMddThhmmss, NOW/DAY, NOW-7DAYS, ...
page_size query integer(int32) false Number of Items per page. Max 500
Authorization header string true JWT access token

Example responses

200 Response

{
    "Total": 0,
    "Results": [
        {
            "timestamp": "string",
            "name": "string",
            "url": "string",
            "success": "string",
            "resultCode": "string",
            "duration": "string",
            "user_AuthenticatedId": "string",
        }
    ]
}

Responses

Status Meaning Description Schema
200 OK Success Inline
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

Response Schema

Content Endpoints Group

GET /content/item_ById

Code samples

# You can also use wget
curl -X GET /content/item_ById \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/item_ById HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/item_ById',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/item_ById',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/item_ById', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/item_ById', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/item_ById");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/item_ById", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/item_ById

Get the item whit the Id.

You will be able to access an individual element through its id. The required field (item_id) to perform the query is PackageInfo => id
If the item_id you have provided does not correspond to any content you will get 404 Not Found
If the item_id you have provided corresponds to some content but it is not in your contracted products, you will get 403 Forbbiden

URL Parameters

Name In Type Required Description
item_id query integer(int64) true Item Id(Required)
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "product_id":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /content/items_ByProductId

Code samples

# You can also use wget
curl -X GET /content/items_ByProductId \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/items_ByProductId HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/items_ByProductId',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/items_ByProductId',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/items_ByProductId', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/items_ByProductId', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/items_ByProductId");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/items_ByProductId", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/items_ByProductId

Get Item List (news) of the Product Id

This is possibly the endpoint most used by our clients. Through it you will be able to obtain the news that a contracted product contains.
Through the required product_id parameter that you have purchased with the /account/products endpoint, you will obtain the contents of a specific product. With the rest of the parameters you can improve or refine your search to fit your needs.
If the product has no content you will get a 404 Not Found
If you request a product that you do not have contracted, you will get a 403 Forbbiden

URL Parameters

Name In Type Required Description
product_id query string false Product Id(Required)
sort query string false Values: asc = ascending (older results first) / desc (default value) = descending (newer results first)
date_from query string false Starting date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-24HOURS/HOUR, NOW-7DAYS/DAY, ...
date_to query string false Ending date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-7DAYS, ...
start_itemId query integer(int64) false Starting Item Id, Returns items with Id greater than the given Item Id
page query integer(int32) false Number of requested page (starting from 0)
page_size query integer(int32) false Number of Items per page. Max 500
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "product_id":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /content/search

Code samples

# You can also use wget
curl -X GET /content/search \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/search HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/search',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/search',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/search', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/search

Free Search inside all your products

With this endpoint you can perform free searches in the content of your contracted products.
If your search does not produce results you will get a 404 Not Found

URL Parameters

Name In Type Required Description
q query string false Search Term(Required)
sort query string false Values: asc = ascending (older results first) / desc = descending (newer results first)
page query integer(int32) false Number of requested page
page_size query integer(int32) false Number of Items per page. Max 500
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "product_id":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /content/search_InProductId

Code samples

# You can also use wget
curl -X GET /content/search_InProductId \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/search_InProductId HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/search_InProductId',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/search_InProductId',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/search_InProductId', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/search_InProductId', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/search_InProductId");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/search_InProductId", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/search_InProductId

Perform a search with a query string in one or more Product that you have contracted

Through it you will be able to make searched based on a query string and one or more specified products that you have contrated.


You can use de q parameter to set a search string. This is Required in this endpoint.
Through the required product_id parameter that you have purchased with the /account/products endpoint, you will obtain the contents of a specific product. With the rest of the parameters you can improve or refine your search to fit your needs. You can use one or serveral.
If the combination of product_id and query string has no content in your contracted products you will get a 404 Not Found
If you request a product that you do not have contracted, you will get a 403 Forbbiden

URL Parameters

Name In Type Required Description
q query string false Search Term(Required)
product_id query string false Product Id(Required) (One or several comma separated)
sort query string false Values: asc = ascending (older results first) / desc (default value) = descending (newer results first)
date_from query string false Starting date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-24HOURS/HOUR, NOW-7DAYS/DAY, ...
date_to query string false Ending date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-7DAYS, ...
start_itemId query integer(int64) false Starting Item Id, Returns items with Id greater than the given Item Id
page query integer(int32) false Number of requested page (starting from 0)
page_size query integer(int32) false Number of Items per page. Max 500
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "product_id":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /content/search_InIptcCategoryCode

Code samples

# You can also use wget
curl -X GET /content/search_InIptcCategoryCode \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/search_InIptcCategoryCode HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/search_InIptcCategoryCode',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/search_InIptcCategoryCode',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/search_InIptcCategoryCode', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/search_InIptcCategoryCode', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/search_InIptcCategoryCode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/search_InIptcCategoryCode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/search_InIptcCategoryCode

Get Item List (news) of the Iptc Code in your Products

Through it you will be able to obtain the news that are in your contracted product and are of one or more specific parameters.
You can use de q parameter to set a search string. This is Not Required.
Through the required code parameter that you can obtain in /models/get_model_data?model_to_query=iptc endpoint, you will obtain the contents of one or more specific Iptc Categories in your contracted products. With the rest of the parameters you can improve or refine your search to fit your needs.
If the combination of Iptc Code and query string has no content in your contracted products you will get a 404 Not Found

URL Parameters

Name In Type Required Description
q query string false Search Term
code query string false Iptc Code(Required) (One or several comma separated)
sort query string false Values: asc = ascending (older results first) / desc (default value) = descending (newer results first)
date_from query string false Starting date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-24HOURS/HOUR, NOW-7DAYS/DAY, ...
date_to query string false Ending date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-7DAYS, ...
start_itemId query integer(int64) false Starting Item Id, Returns items with Id greater than the given Item Id
page query integer(int32) false Number of requested page (starting from 0)
page_size query integer(int32) false Number of Items per page. Max 500
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "code":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GET /content/search_InFormat

Code samples

# You can also use wget
curl -X GET /content/search_InFormat \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /content/search_InFormat HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',
  'Authorization':'Bearer [Bearer Token]'
};

fetch('/content/search_InFormat',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/content/search_InFormat',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/content/search_InFormat', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/content/search_InFormat', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/content/search_InFormat");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/content/search_InFormat", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /content/search_InFormat

Get Item List (news) of the Format in your Products

Through it you will be able to obtain the news that are in your contracted product and are of one or more specific parameters.
You can use de q parameter to set a search string. This is Not Required.
Through the required format parameter that you can obtain in /models/get_model_data?model_to_query=format endpoint, you will obtain the contents of one or more specific formats in your contracted products. With the rest of the parameters you can improve or refine your search to fit your needs.
If the combination of format and query string has no content in your contracted products you will get a 404 Not Found

URL Parameters

Name In Type Required Description
q query string false Search Term
format_id query string false Format Id(Required) (One or several comma separated)
sort query string false Values: asc = ascending (older results first) / desc (default value) = descending (newer results first)
date_from query string false Starting date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-24HOURS/HOUR, NOW-7DAYS/DAY, ...
date_to query string false Ending date: yyyyMMdd, yyyyMMddThhmmss, NOW/DAY, NOW-7DAYS, ...
start_itemId query integer(int64) false Starting Item Id, Returns items with Id greater than the given Item Id
page query integer(int32) false Number of requested page (starting from 0)
page_size query integer(int32) false Number of Items per page. Max 500
lang_code query string false Language code (ISO-XX)Admited values:ES / EN / AR / PT / CA Default: ES
format query string false (Optional)You can set the contentype(format) you want as a QueryString parameter in the Uri or as Accept Header in Request
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "item_id":0,
      "q":"string",
      "format_id":"string",
      "sort":"string",
      "page":0,
      "page_size":0,
      "lang_code":"string",
      "date_from":"string",
      "date_to":"string",
      "start_itemId":0,
      "versionefe":0,
      "client_id":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "items":[
         {
            "packageInfo":{
               "id":0,
               "version":0,
               "format":{
                  "id":0,
                  "description":"string"
               },
               "date":"string",
               "firstCreated":"string",
               "guide":"string",
               "guideComplements":[
                  {
                     "id":"string",
                     "description":"string"
                  }
               ],
               "title":"string",
               "subtitle":"string",
               "summary":"string",
               "text":"string",
               "wordsCount":0,
               "keyWords":[
                  "string"
               ],
               "metaData":{
                  "classification":{
                     "id":0,
                     "description":"string"
                  },
                  "langCode":"string",
                  "relevance":{
                     "id":0,
                     "description":"string"
                  },
                  "iptcList":[
                     {
                        "code":"string",
                        "descriptionlevel1":"string",
                        "descriptionlevel2":"string",
                        "descriptionlevel3":"string"
                     }
                  ],
                  "geoProperties":{
                     "area":"string",
                     "countryCode":"string",
                     "region":"string",
                     "city":"string"
                  },
                  "source":"string",
                  "credit":"string",
                  "editor":"string",
                  "authors":[
                     "string"
                  ]
               },
               "objectsCount":{
                  "total":0,
                  "texts":0,
                  "photos":0,
                  "infographics":0,
                  "audios":0,
                  "videos":0,
                  "files":0
               }
            },
            "objects":[
               {
                  "id":0,
                  "format":{
                     "id":0,
                     "description":"string"
                  },
                  "date":"string",
                  "firstCreated":"string",
                  "guide":"string",
                  "guideComplements":[
                     {
                        "id":"string",
                        "description":"string"
                     }
                  ],
                  "title":"string",
                  "subtitle":"string",
                  "summary":"string",
                  "text":"string",
                  "wordsCount":0,
                  "keyWords":[
                     "string"
                  ],
                  "tabSeparatedText":true,
                  "richText":true,
                  "imageProperties":{
                     "orientation":{
                        "code":"string",
                        "description":"string"
                     },
                     "color":{
                        "code":"string",
                        "description":"string"
                     },
                     "plane":{
                        "code":"string",
                        "description":"string"
                     }
                  },
                  "audioProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "videoProperties":{
                     "type":"string",
                     "duration":0,
                     "locution":"string",
                     "timeline":"string",
                     "transcription":"string"
                  },
                  "metaData":{
                     "classification":{
                        "id":0,
                        "description":"string"
                     },
                     "langCode":"string",
                     "relevance":{
                        "id":0,
                        "description":"string"
                     },
                     "iptcList":[
                        {
                           "code":"string",
                           "descriptionlevel1":"string",
                           "descriptionlevel2":"string",
                           "descriptionlevel3":"string"
                        }
                     ],
                     "geoProperties":{
                        "area":"string",
                        "countryCode":"string",
                        "region":"string",
                        "city":"string"
                     },
                     "source":"string",
                     "credit":"string",
                     "editor":"string",
                     "authors":[
                        "string"
                     ]
                  },
                  "files":[
                     {
                        "formatIdentifier": "string",
                        "fileName":"string",
                        "url":"string",
                        "mimeType":"string",
                        "width":0,
                        "height":0,
                        "bpp":0,
                        "bitrateKbps":0,
                        "sizeBytes":0
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ContentResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

Files

Get

Code samples

# You can also use wget
curl -X GET /files \


GET /files HTTP/1.1




const headers = {
  };

fetch('/files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
}

result = RestClient.get '/files',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
}

r = requests.get('/files', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/files', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /files

URL Parameters

Name In Type Required Description

Responses

Status Meaning Description Schema
200 OK Success None

Models

Get

Code samples

# You can also use wget
curl -X GET /models \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /models HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',

  'Authorization':'Bearer [Bearer Token]'
};

fetch('/models',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',,
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/models',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',,
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/models', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/models', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/models");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/models", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /models

Get a modelname list of the queryable Model Collections aviable like Iptc, Guide Complements

Through this endpoint you will be able to obtain a list of the modelnames of the model collections used in the API.

With a obteined modelname you will be able to consult the /get_model_data endopoint to get the information of the desired queryable model

Parameters

Name In Type Required Description
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "lang_code":"string",
      "model_to_query":"string",
      "text_filter":"string",
      "int_filter":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "modelItems":[
         {

         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ModelResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

GetModelData

Code samples

# You can also use wget
curl -X GET /models/get_model_data \
  -H 'Accept: text/plain; version=1.0' \
  -H 'Authorization: Bearer [Bearer Token]'


GET /models/get_model_data HTTP/1.1

Accept: text/plain; version=1.0
Authorization: Bearer [Bearer Token]



const headers = {
  'Accept':'text/plain; version=1.0',

  'Authorization':'Bearer [Bearer Token]'
};

fetch('/models/get_model_data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain; version=1.0',,
  'Authorization' => 'Bearer [Bearer Token]'
}

result = RestClient.get '/models/get_model_data',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'text/plain; version=1.0',,
  'Authorization': 'Bearer [Bearer Token]'
}

r = requests.get('/models/get_model_data', headers = headers)

print(r.json())


<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'text/plain; version=1.0',
    'Authorization' => 'Bearer [Bearer Token]',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/models/get_model_data', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...


URL obj = new URL("/models/get_model_data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"text/plain; version=1.0"},
        "Authorization": []string{"Bearer [Bearer Token]"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/models/get_model_data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /models/get_model_data

Get a collection of requested model items

With this endpoint you are going to obtain the collection of items that make up some models used by the API such as IPTC, Geographical Areas, etc.
If the modelname that you request does not exist you will get a 404 Not Found

URL Parameters

Name In Type Required Description
model_to_query query string false none
text_filter query string false none
int_filter query integer(int32) false none
lang_code query string false none
Authorization header string true JWT access token

Example responses

200 Response

{
   "httpResponse":{
      "code":0,
      "status":"string"
   },
   "parameters":{
      "lang_code":"string",
      "model_to_query":"string",
      "text_filter":"string",
      "int_filter":0
   },
   "data":{
      "envelope":{
         "itemsCount":0,
         "totalFound":0
      },
      "modelItems":[
         {

         }
      ]
   }
}

Responses

Status Meaning Description Schema
200 OK Success ModelResponse
400 Bad Request Bad Request ProblemDetails
401 Unauthorized Unauthorized ProblemDetails
404 Not Found Not Found ProblemDetails
429 Too Many Requests Client Error ProblemDetails
500 Internal Server Error Server Error ProblemDetails
503 Service Unavailable Server Error ProblemDetails

Schemas

ProblemDetails

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

Properties

Name Type Required Restrictions Description
additionalProperties object false none none
type string false none none
title string false none none
status integer(int32) false none none
detail string false none none
instance string false none none

ProductResponse

{
  "httpResponse": {
    "code": 0,
    "status": "string"
  },
  "parameters": {
    "lang_code": "string",
    "client_id": 0,
    "id_Servicio": 0,
    "idPaquete": 0
  },
  "data": {
    "envelope": {
      "itemsCount": 0,
      "totalFound": 0
    },
    "products": [
      {
        "id": 0,
        "name": "string",
        "format": {
          "id": 0,
          "description": "string"
        },
        "classification": {
          "id": 0,
          "description": "string"
        }
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
httpResponse HttpResponse false none none
parameters ProductsParameters false none none
data DataProducts false none none

HttpResponse

{
  "code": 0,
  "status": "string"
}

Properties

Name Type Required Restrictions Description
code integer(int32) false none none
status string false none none

ProductsParameters

{
  "lang_code": "string",
  "client_id": 0,
  "id_Servicio": 0,
  "idPaquete": 0
}

Properties

Name Type Required Restrictions Description
lang_code string false none none
client_id integer(int32) false none none
id_Servicio integer(int32) false none none
idPaquete integer(int32) false none none

DataProducts

{
  "envelope": {
    "itemsCount": 0,
    "totalFound": 0
  },
  "products": [
    {
      "id": 0,
      "name": "string",
      "format": {
        "id": 0,
        "description": "string"
      },
      "classification": {
        "id": 0,
        "description": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
envelope Envelope false none none
products [Product] false none none

Envelope

{
  "itemsCount": 0,
  "totalFound": 0
}

Properties

Name Type Required Restrictions Description
itemsCount integer(int32) false none none
totalFound integer(int32) false none none

Product

{
  "id": 0,
  "name": "string",
  "format": {
    "id": 0,
    "description": "string"
  },
  "classification": {
    "id": 0,
    "description": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string false none none
format DataId false none none
classification DataId false none none

DataId

{
  "id": 0,
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
description string false none none

ContentResponse

{
  "httpResponse": {
    "code": 0,
    "status": "string"
  },
  "parameters": {
    "item_id": 0,
    "q": "string",
    "product_id": "string",
    "sort": "string",
    "page": 0,
    "page_size": 0,
    "lang_code": "string",
    "date_from": "string",
    "date_to": "string",
    "start_itemId": 0,
    "versionefe": 0,
    "client_id": 0
  },
  "data": {
    "envelope": {
      "itemsCount": 0,
      "totalFound": 0
    },
    "items": [
      {
        "packageInfo": {
          "id": 0,
          "version": 0,
          "format": {
            "id": 0,
            "description": "string"
          },
          "date": "string",
          "firstCreated": "string",
          "guide": "string",
          "guideComplements": [
            {
              "id": "string",
              "description": "string"
            }
          ],
          "title": "string",
          "subtitle": "string",
          "summary": "string",
          "text": "string",
          "wordsCount": 0,
          "keyWords": [
            "string"
          ],
          "metaData": {
            "classification": {
              "id": 0,
              "description": "string"
            },
            "langCode": "string",
            "relevance": {
              "id": 0,
              "description": "string"
            },
            "iptcList": [
              {
                "code": "string",
                "descriptionlevel1": "string",
                "descriptionlevel2": "string",
                "descriptionlevel3": "string"
              }
            ],
            "geoProperties": {
              "area": "string",
              "countryCode": "string",
              "region": "string",
              "city": "string"
            },
            "source": "string",
            "credit": "string",
            "editor": "string",
            "authors": [
              "string"
            ]
          },
          "objectsCount": {
            "total": 0,
            "texts": 0,
            "photos": 0,
            "infographics": 0,
            "audios": 0,
            "videos": 0,
            "files": 0
          }
        },
        "objects": [
          {
            "id": 0,
            "format": {
              "id": 0,
              "description": "string"
            },
            "date": "string",
            "firstCreated": "string",
            "guide": "string",
            "guideComplements": [
              {
                "id": "string",
                "description": "string"
              }
            ],
            "title": "string",
            "subtitle": "string",
            "summary": "string",
            "text": "string",
            "wordsCount": 0,
            "keyWords": [
              "string"
            ],
            "tabSeparatedText": true,
            "richText": true,
            "imageProperties": {
              "orientation": {
                "code": "string",
                "description": "string"
              },
              "color": {
                "code": "string",
                "description": "string"
              },
              "plane": {
                "code": "string",
                "description": "string"
              }
            },
            "audioProperties": {
              "type": "string",
              "duration": 0,
              "locution": "string",
              "timeline": "string",
              "transcription": "string"
            },
            "videoProperties": {
              "type": "string",
              "duration": 0,
              "locution": "string",
              "timeline": "string",
              "transcription": "string"
            },
            "metaData": {
              "classification": {
                "id": 0,
                "description": "string"
              },
              "langCode": "string",
              "relevance": {
                "id": 0,
                "description": "string"
              },
              "iptcList": [
                {
                  "code": "string",
                  "descriptionlevel1": "string",
                  "descriptionlevel2": "string",
                  "descriptionlevel3": "string"
                }
              ],
              "geoProperties": {
                "area": "string",
                "countryCode": "string",
                "region": "string",
                "city": "string"
              },
              "source": "string",
              "credit": "string",
              "editor": "string",
              "authors": [
                "string"
              ]
            },
            "files": [
              {
                "formatIdentifier": "string",
                "fileName": "string",
                "url": "string",
                "mimeType": "string",
                "width": 0,
                "height": 0,
                "bpp": 0,
                "bitrateKbps": 0,
                "sizeBytes": 0
              }
            ]
          }
        ]
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
httpResponse HttpResponse false none none
parameters ContentParameters false none none
data DataItems false none none

ContentParameters

{
  "item_id": 0,
  "q": "string",
  "product_id": "string",
  "sort": "string",
  "page": 0,
  "page_size": 0,
  "lang_code": "string",
  "date_from": "string",
  "date_to": "string",
  "start_itemId": 0,
  "versionefe": 0,
  "client_id": 0
}

Properties

Name Type Required Restrictions Description
item_id integer(int64) false none none
q string false none none
product_id string false none none
sort string false none none
page integer(int32) false none none
page_size integer(int32) false none none
lang_code string false none none
date_from string false none none
date_to string false none none
start_itemId integer(int64) false none none
versionefe integer(int64) false none none
client_id integer(int32) false none none

DataItems

{
  "envelope": {
    "itemsCount": 0,
    "totalFound": 0
  },
  "items": [
    {
      "packageInfo": {
        "id": 0,
        "version": 0,
        "format": {
          "id": 0,
          "description": "string"
        },
        "date": "string",
        "firstCreated": "string",
        "guide": "string",
        "guideComplements": [
          {
            "id": "string",
            "description": "string"
          }
        ],
        "title": "string",
        "subtitle": "string",
        "summary": "string",
        "text": "string",
        "wordsCount": 0,
        "keyWords": [
          "string"
        ],
        "metaData": {
          "classification": {
            "id": 0,
            "description": "string"
          },
          "langCode": "string",
          "relevance": {
            "id": 0,
            "description": "string"
          },
          "iptcList": [
            {
              "code": "string",
              "descriptionlevel1": "string",
              "descriptionlevel2": "string",
              "descriptionlevel3": "string"
            }
          ],
          "geoProperties": {
            "area": "string",
            "countryCode": "string",
            "region": "string",
            "city": "string"
          },
          "source": "string",
          "credit": "string",
          "editor": "string",
          "authors": [
            "string"
          ]
        },
        "objectsCount": {
          "total": 0,
          "texts": 0,
          "photos": 0,
          "infographics": 0,
          "audios": 0,
          "videos": 0,
          "files": 0
        }
      },
      "objects": [
        {
          "id": 0,
          "format": {
            "id": 0,
            "description": "string"
          },
          "date": "string",
          "firstCreated": "string",
          "guide": "string",
          "guideComplements": [
            {
              "id": "string",
              "description": "string"
            }
          ],
          "title": "string",
          "subtitle": "string",
          "summary": "string",
          "text": "string",
          "wordsCount": 0,
          "keyWords": [
            "string"
          ],
          "tabSeparatedText": true,
          "richText": true,
          "imageProperties": {
            "orientation": {
              "code": "string",
              "description": "string"
            },
            "color": {
              "code": "string",
              "description": "string"
            },
            "plane": {
              "code": "string",
              "description": "string"
            }
          },
          "audioProperties": {
            "type": "string",
            "duration": 0,
            "locution": "string",
            "timeline": "string",
            "transcription": "string"
          },
          "videoProperties": {
            "type": "string",
            "duration": 0,
            "locution": "string",
            "timeline": "string",
            "transcription": "string"
          },
          "metaData": {
            "classification": {
              "id": 0,
              "description": "string"
            },
            "langCode": "string",
            "relevance": {
              "id": 0,
              "description": "string"
            },
            "iptcList": [
              {
                "code": "string",
                "descriptionlevel1": "string",
                "descriptionlevel2": "string",
                "descriptionlevel3": "string"
              }
            ],
            "geoProperties": {
              "area": "string",
              "countryCode": "string",
              "region": "string",
              "city": "string"
            },
            "source": "string",
            "credit": "string",
            "editor": "string",
            "authors": [
              "string"
            ]
          },
          "files": [
            {
              "formatIdentifier": "string",
              "fileName": "string",
              "url": "string",
              "mimeType": "string",
              "width": 0,
              "height": 0,
              "bpp": 0,
              "bitrateKbps": 0,
              "sizeBytes": 0
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
envelope Envelope false none none
items [Item] false none none

Item

{
  "packageInfo": {
    "id": 0,
    "version": 0,
    "format": {
      "id": 0,
      "description": "string"
    },
    "date": "string",
    "firstCreated": "string",
    "guide": "string",
    "guideComplements": [
      {
        "id": "string",
        "description": "string"
      }
    ],
    "title": "string",
    "subtitle": "string",
    "summary": "string",
    "text": "string",
    "wordsCount": 0,
    "keyWords": [
      "string"
    ],
    "metaData": {
      "classification": {
        "id": 0,
        "description": "string"
      },
      "langCode": "string",
      "relevance": {
        "id": 0,
        "description": "string"
      },
      "iptcList": [
        {
          "code": "string",
          "descriptionlevel1": "string",
          "descriptionlevel2": "string",
          "descriptionlevel3": "string"
        }
      ],
      "geoProperties": {
        "area": "string",
        "countryCode": "string",
        "region": "string",
        "city": "string"
      },
      "source": "string",
      "credit": "string",
      "editor": "string",
      "authors": [
        "string"
      ]
    },
    "objectsCount": {
      "total": 0,
      "texts": 0,
      "photos": 0,
      "infographics": 0,
      "audios": 0,
      "videos": 0,
      "files": 0
    }
  },
  "objects": [
    {
      "id": 0,
      "format": {
        "id": 0,
        "description": "string"
      },
      "date": "string",
      "firstCreated": "string",
      "guide": "string",
      "guideComplements": [
        {
          "id": "string",
          "description": "string"
        }
      ],
      "title": "string",
      "subtitle": "string",
      "summary": "string",
      "text": "string",
      "wordsCount": 0,
      "keyWords": [
        "string"
      ],
      "tabSeparatedText": true,
      "richText": true,
      "imageProperties": {
        "orientation": {
          "code": "string",
          "description": "string"
        },
        "color": {
          "code": "string",
          "description": "string"
        },
        "plane": {
          "code": "string",
          "description": "string"
        }
      },
      "audioProperties": {
        "type": "string",
        "duration": 0,
        "locution": "string",
        "timeline": "string",
        "transcription": "string"
      },
      "videoProperties": {
        "type": "string",
        "duration": 0,
        "locution": "string",
        "timeline": "string",
        "transcription": "string"
      },
      "metaData": {
        "classification": {
          "id": 0,
          "description": "string"
        },
        "langCode": "string",
        "relevance": {
          "id": 0,
          "description": "string"
        },
        "iptcList": [
          {
            "code": "string",
            "descriptionlevel1": "string",
            "descriptionlevel2": "string",
            "descriptionlevel3": "string"
          }
        ],
        "geoProperties": {
          "area": "string",
          "countryCode": "string",
          "region": "string",
          "city": "string"
        },
        "source": "string",
        "credit": "string",
        "editor": "string",
        "authors": [
          "string"
        ]
      },
      "files": [
        {
          "formatIdentifier": "string",
          "fileName": "string",
          "url": "string",
          "mimeType": "string",
          "width": 0,
          "height": 0,
          "bpp": 0,
          "bitrateKbps": 0,
          "sizeBytes": 0
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
packageInfo PackageInfo false none none
objects [Object] false none none

PackageInfo

{
  "id": 0,
  "version": 0,
  "format": {
    "id": 0,
    "description": "string"
  },
  "date": "string",
  "firstCreated": "string",
  "guide": "string",
  "guideComplements": [
    {
      "id": "string",
      "description": "string"
    }
  ],
  "title": "string",
  "subtitle": "string",
  "summary": "string",
  "text": "string",
  "wordsCount": 0,
  "keyWords": [
    "string"
  ],
  "metaData": {
    "classification": {
      "id": 0,
      "description": "string"
    },
    "langCode": "string",
    "relevance": {
      "id": 0,
      "description": "string"
    },
    "iptcList": [
      {
        "code": "string",
        "descriptionlevel1": "string",
        "descriptionlevel2": "string",
        "descriptionlevel3": "string"
      }
    ],
    "geoProperties": {
      "area": "string",
      "countryCode": "string",
      "region": "string",
      "city": "string"
    },
    "source": "string",
    "credit": "string",
    "editor": "string",
    "authors": [
      "string"
    ]
  },
  "objectsCount": {
    "total": 0,
    "texts": 0,
    "photos": 0,
    "infographics": 0,
    "audios": 0,
    "videos": 0,
    "files": 0
  }
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
version integer(int64) false none none
format DataId false none none
date string false none none
firstCreated string false none none
guide string false none none
guideComplements [GuideComplement] false none none
title string false none none
subtitle string false none none
summary string false none none
text string false none none
wordsCount integer(int32) false none none
keyWords [string] false none none
metaData MetaData false none none
objectsCount ObjectsCount false none none

Object

{
  "id": 0,
  "format": {
    "id": 0,
    "description": "string"
  },
  "date": "string",
  "firstCreated": "string",
  "guide": "string",
  "guideComplements": [
    {
      "id": "string",
      "description": "string"
    }
  ],
  "title": "string",
  "subtitle": "string",
  "summary": "string",
  "text": "string",
  "wordsCount": 0,
  "keyWords": [
    "string"
  ],
  "tabSeparatedText": true,
  "richText": true,
  "imageProperties": {
    "orientation": {
      "code": "string",
      "description": "string"
    },
    "color": {
      "code": "string",
      "description": "string"
    },
    "plane": {
      "code": "string",
      "description": "string"
    }
  },
  "audioProperties": {
    "type": "string",
    "duration": 0,
    "locution": "string",
    "timeline": "string",
    "transcription": "string"
  },
  "videoProperties": {
    "type": "string",
    "duration": 0,
    "locution": "string",
    "timeline": "string",
    "transcription": "string"
  },
  "metaData": {
    "classification": {
      "id": 0,
      "description": "string"
    },
    "langCode": "string",
    "relevance": {
      "id": 0,
      "description": "string"
    },
    "iptcList": [
      {
        "code": "string",
        "descriptionlevel1": "string",
        "descriptionlevel2": "string",
        "descriptionlevel3": "string"
      }
    ],
    "geoProperties": {
      "area": "string",
      "countryCode": "string",
      "region": "string",
      "city": "string"
    },
    "source": "string",
    "credit": "string",
    "editor": "string",
    "authors": [
      "string"
    ]
  },
  "files": [
    {
      "formatIdentifier": "string",
      "fileName": "string",
      "url": "string",
      "mimeType": "string",
      "width": 0,
      "height": 0,
      "bpp": 0,
      "bitrateKbps": 0,
      "sizeBytes": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
format DataId false none none
date string false none none
firstCreated string false none none
guide string false none none
guideComplements [GuideComplement] false none none
title string false none none
subtitle string false none none
summary string false none none
text string false none none
wordsCount integer(int32) false none none
keyWords [string] false none none
tabSeparatedText boolean false none none
richText boolean false none none
imageProperties ImageProperties false none none
audioProperties AudioProperties false none none
videoProperties VideoProperties false none none
metaData MetaData false none none
files [File] false none none

GuideComplement

{
  "id": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
description string false none none

MetaData

{
  "classification": {
    "id": 0,
    "description": "string"
  },
  "langCode": "string",
  "relevance": {
    "id": 0,
    "description": "string"
  },
  "iptcList": [
    {
      "code": "string",
      "descriptionlevel1": "string",
      "descriptionlevel2": "string",
      "descriptionlevel3": "string"
    }
  ],
  "geoProperties": {
    "area": "string",
    "countryCode": "string",
    "region": "string",
    "city": "string"
  },
  "source": "string",
  "credit": "string",
  "editor": "string",
  "authors": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
classification DataId false none none
langCode string false none none
relevance DataId false none none
iptcList [Iptc] false none none
geoProperties GeoProperties false none none
source string false none none
credit string false none none
editor string false none none
authors [string] false none none

ObjectsCount

{
  "total": 0,
  "texts": 0,
  "photos": 0,
  "infographics": 0,
  "audios": 0,
  "videos": 0,
  "files": 0
}

Properties

Name Type Required Restrictions Description
total integer(int32) false none none
texts integer(int32) false none none
photos integer(int32) false none none
infographics integer(int32) false none none
audios integer(int32) false none none
videos integer(int32) false none none
files integer(int32) false none none

ImageProperties

{
  "orientation": {
    "code": "string",
    "description": "string"
  },
  "color": {
    "code": "string",
    "description": "string"
  },
  "plane": {
    "code": "string",
    "description": "string"
  }
}

Properties

Name Type Required Restrictions Description
orientation DataCode false none none
color DataCode false none none
plane DataCode false none none

AudioProperties

{
  "type": "string",
  "duration": 0,
  "locution": "string",
  "timeline": "string",
  "transcription": "string"
}

Properties

Name Type Required Restrictions Description
type string false none none
duration integer(int32) false none none
locution string false none none
timeline string false none none
transcription string false none none

VideoProperties

{
  "type": "string",
  "duration": 0,
  "locution": "string",
  "timeline": "string",
  "transcription": "string"
}

Properties

Name Type Required Restrictions Description
type string false none none
duration integer(int32) false none none
locution string false none none
timeline string false none none
transcription string false none none

File

{
  "formatIdentifier": "string",
  "fileName": "string",
  "url": "string",
  "mimeType": "string",
  "width": 0,
  "height": 0,
  "bpp": 0,
  "bitrateKbps": 0,
  "sizeBytes": 0
}

Properties

Name Type Required Restrictions Description
formatIdentifier string false none none
fileName string false none none
url string false none none
mimeType string false none none
width integer(int32) false none none
height integer(int32) false none none
bpp integer(int32) false none none
bitrateKbps number(double) false none none
sizeBytes integer(int64) false none none

Iptc

{
  "code": "string",
  "descriptionlevel1": "string",
  "descriptionlevel2": "string",
  "descriptionlevel3": "string"
}

Properties

Name Type Required Restrictions Description
code string false none none
descriptionlevel1 string false none none
descriptionlevel2 string false none none
descriptionlevel3 string false none none

GeoProperties

{
  "area": "string",
  "countryCode": "string",
  "region": "string",
  "city": "string"
}

Properties

Name Type Required Restrictions Description
area string false none none
countryCode string false none none
region string false none none
city string false none none

DataCode

{
  "code": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
code string false none none
description string false none none

ModelResponse

{
  "httpResponse": {
    "code": 0,
    "status": "string"
  },
  "parameters": {
    "lang_code": "string",
    "model_to_query": "string",
    "text_filter": "string",
    "int_filter": 0
  },
  "data": {
    "envelope": {
      "itemsCount": 0,
      "totalFound": 0
    },
    "modelItems": [
      {}
    ]
  }
}

Properties

Name Type Required Restrictions Description
httpResponse HttpResponse false none none
parameters ModelParameters false none none
data DataModels false none none

ModelParameters

{
  "lang_code": "string",
  "model_to_query": "string",
  "text_filter": "string",
  "int_filter": 0
}

Properties

Name Type Required Restrictions Description
lang_code string false none none
model_to_query string false none none
text_filter string false none none
int_filter integer(int32) false none none

DataModels

{
  "envelope": {
    "itemsCount": 0,
    "totalFound": 0
  },
  "modelItems": [
    {}
  ]
}

Properties

Name Type Required Restrictions Description
envelope Envelope false none none
modelItems [object] false none none

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
Shell HTTP JavaScript Ruby Python PHP Java Go