RankingsApi v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Email: Iberinform Web: Iberinform
Authentication
-
API Key (APIKeyHeader)
- Parameter Name: X-IBM-Client-Id, in: header.
-
API Key (ClientSecretHeader)
- Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
Default
get__rankings
Code samples
URL obj = new URL("https://$(catalog.host)/rankingsapi/rankings");
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());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/rankingsapi/rankings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/rankingsapi/rankings HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/rankingsapi/rankings', 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());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/rankingsapi/rankings', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/rankingsapi/rankings',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/rankingsapi/rankings \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /rankings
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
language | query | string | false | idioma |
Example responses
200 Response
"[{"rankingID":"01","description":"Ventas","units":"Euros","order":"desc","limit":1000},{"rankingID":"02","description":"Número de Empleados","units":"Unidades","order":"desc","limit":1500},{"rankingID":"03","description":"Fecha de Constitución","units":"Fecha","order":"desc","limit":1000}]"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | rankings |
401 | Unauthorized | Unauthorized | ErrorDetail |
403 | Forbidden | Forbidden | ErrorDetail |
404 | Not Found | Recurso no encontrado | ErrorDetail |
500 | Internal Server Error | Internal error | ErrorDetail |
get__rankings_{rankingID}
Code samples
URL obj = new URL("https://$(catalog.host)/rankingsapi/rankings/{rankingID}");
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());
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/rankingsapi/rankings/{rankingID}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://$(catalog.host)/rankingsapi/rankings/{rankingID} HTTP/1.1
Accept: application/json
'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$(catalog.host)/rankingsapi/rankings/{rankingID}', 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());
}
// ...
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/rankingsapi/rankings/{rankingID}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/rankingsapi/rankings/{rankingID}',
params: {
}, headers: headers
p JSON.parse(result)
# You can also use wget
curl -X GET https://$(catalog.host)/rankingsapi/rankings/{rankingID} \
-H 'Accept: application/json' \
-H 'X-IBM-Client-Id: API_KEY' \
-H 'X-IBM-Client-Secret: API_KEY'
GET /rankings/{rankingID}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | integer(int32) | false | capacidad |
language | query | string | false | Idioma generación |
offset | query | string | false | pagina |
rankingID | path | string | true | identificador de Ranking |
Example responses
200 Response
"{"rankingType":"01","capacity":10,"language":"ES","page":0,"total":1000,"date":"05-12-2019 15:55:06.0","symbol":"€","content":[{"companyID":6334608,"webDescription":"wire-technologies","name":"WIRE TECHNOLOGIES","fullName":"WIRE TECHNOLOGIES SL","tradeName":"WITECH","country":"ESPAÑA","province":"BARCELONA","locality":"GRANOLLERS","rankingValue":" 1.497.900.320.000,00"},{"companyID":6743430,"webDescription":"artesanos-de-la-madera-de-toledo","name":"ARTESANOS DE LA MADERA DE TOLEDO","fullName":"ARTESANOS DE LA MADERA DE TOLEDO SLL","tradeName":"AMT","country":"ESPAÑA","province":"TOLEDO","locality":"VILLACAÑAS","rankingValue":" 957.633.590.000,00"},{"companyID":141417,"webDescription":"ifco-systems-espana","name":"IFCO SYSTEMS ESPAÑA","fullName":"IFCO SYSTEMS ESPAÑA SL","country":"ESPAÑA","province":"VALENCIA","locality":"PICASSENT","rankingValue":" 141.083.509.000,00"},{"companyID":3998567,"webDescription":"antonio-guillin-luana-y-rogelio-dono-pampin","name":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN","fullName":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN Sociedad Civil","country":"ESPAÑA","province":"CORUÑA (A)","locality":"OLEIROS","rankingValue":" 135.000.135.000,00"},{"companyID":6213959,"webDescription":"suministros-industriales-mahofri","name":"SUMINISTROS INDUSTRIALES MAHOFRI","fullName":"SUMINISTROS INDUSTRIALES MAHOFRI SL","country":"ESPAÑA","province":"ALICANTE","locality":"ELCHE","rankingValue":" 61.411.530.000,00"},{"companyID":1994945,"webDescription":"metalab-2010","name":"METALAB 2010","fullName":"METALAB 2010 SL","country":"ESPAÑA","province":"MADRID","locality":"POZUELO DE ALARCON","rankingValue":" 33.000.000.000,00"},{"companyID":6532265,"webDescription":"taoufik-bahdaoui","name":"TAOUFIK BAHDAOUI","fullName":"TAOUFIK BAHDAOUI","tradeName":"LA TIENDA CHOLLOS","country":"ESPAÑA","province":"CIUDAD REAL","locality":"DAIMIEL","rankingValue":" 28.851.326.680,00"},{"companyID":611505,"webDescription":"autocares-carrasco","name":"AUTOCARES CARRASCO","fullName":"AUTOCARES CARRASCO SL","country":"ESPAÑA","province":"MALAGA","locality":"CAMPILLOS","rankingValue":" 28.851.326.680,00"},{"companyID":63770,"webDescription":"mercadona","name":"MERCADONA","fullName":"MERCADONA SA","country":"ESPAÑA","province":"VALENCIA","locality":"TAVERNES BLANQUES","rankingValue":" 19.059.157.000,00"},{"companyID":2265953,"webDescription":"repsol-petroleo","name":"REPSOL PETROLEO","fullName":"REPSOL PETROLEO SA","tradeName":"REPSOL","country":"ESPAÑA","province":"MADRID","locality":"MADRID","rankingValue":" 18.344.171.000,00"}]}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | rankingData |
401 | Unauthorized | Unauthorized | responseError |
403 | Forbidden | Forbidden | responseError |
404 | Not Found | Recurso no encontrado | responseError |
500 | Internal Server Error | Internal error | responseError |
Schemas
ErrorDetail
{
"code": "string",
"message": "string",
"principal": "string",
"status": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
message | string | false | none | none |
principal | string | false | none | none |
status | number(float) | false | none | none |
responseError
{
"code": "1404",
"message": "Resource not found",
"more_info": "This error is produced when ...",
"status": "404"
}
Payload error form
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer(int32) | false | none | Error code |
message | string | false | none | Error message |
more_info | string | false | none | Additional information |
status | integer(int32) | false | none | HttpStatus |
internal_rankingData
"{"rankingType":"01","capacity":10,"language":"ES","page":0,"total":1000,"date":"05-12-2019 15:55:06.0","symbol":"€","content":[{"firmid":6334608,"webDescription":"wire-technologies","name":"WIRE TECHNOLOGIES","fullName":"WIRE TECHNOLOGIES SL","tradeName":"WITECH","country":"ESPAÑA","province":"BARCELONA","locality":"GRANOLLERS","rankingValue":" 1.497.900.320.000,00"},{"firmid":6743430,"webDescription":"artesanos-de-la-madera-de-toledo","name":"ARTESANOS DE LA MADERA DE TOLEDO","fullName":"ARTESANOS DE LA MADERA DE TOLEDO SLL","tradeName":"AMT","country":"ESPAÑA","province":"TOLEDO","locality":"VILLACAÑAS","rankingValue":" 957.633.590.000,00"},{"firmid":141417,"webDescription":"ifco-systems-espana","name":"IFCO SYSTEMS ESPAÑA","fullName":"IFCO SYSTEMS ESPAÑA SL","country":"ESPAÑA","province":"VALENCIA","locality":"PICASSENT","rankingValue":" 141.083.509.000,00"},{"firmid":3998567,"webDescription":"antonio-guillin-luana-y-rogelio-dono-pampin","name":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN","fullName":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN Sociedad Civil","country":"ESPAÑA","province":"CORUÑA (A)","locality":"OLEIROS","rankingValue":" 135.000.135.000,00"},{"firmid":6213959,"webDescription":"suministros-industriales-mahofri","name":"SUMINISTROS INDUSTRIALES MAHOFRI","fullName":"SUMINISTROS INDUSTRIALES MAHOFRI SL","country":"ESPAÑA","province":"ALICANTE","locality":"ELCHE","rankingValue":" 61.411.530.000,00"},{"firmid":1994945,"webDescription":"metalab-2010","name":"METALAB 2010","fullName":"METALAB 2010 SL","country":"ESPAÑA","province":"MADRID","locality":"POZUELO DE ALARCON","rankingValue":" 33.000.000.000,00"},{"firmid":6532265,"webDescription":"taoufik-bahdaoui","name":"TAOUFIK BAHDAOUI","fullName":"TAOUFIK BAHDAOUI","tradeName":"LA TIENDA CHOLLOS","country":"ESPAÑA","province":"CIUDAD REAL","locality":"DAIMIEL","rankingValue":" 28.851.326.680,00"},{"firmid":611505,"webDescription":"autocares-carrasco","name":"AUTOCARES CARRASCO","fullName":"AUTOCARES CARRASCO SL","country":"ESPAÑA","province":"MALAGA","locality":"CAMPILLOS","rankingValue":" 28.851.326.680,00"},{"firmid":63770,"webDescription":"mercadona","name":"MERCADONA","fullName":"MERCADONA SA","country":"ESPAÑA","province":"VALENCIA","locality":"TAVERNES BLANQUES","rankingValue":" 19.059.157.000,00"},{"firmid":2265953,"webDescription":"repsol-petroleo","name":"REPSOL PETROLEO","fullName":"REPSOL PETROLEO SA","tradeName":"REPSOL","country":"ESPAÑA","province":"MADRID","locality":"MADRID","rankingValue":" 18.344.171.000,00"}]}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
rankingType | string | false | none | none |
capacity | number | false | none | none |
language | string | false | none | none |
page | number | false | none | none |
total | number | false | none | none |
date | string | false | none | none |
symbol | string | false | none | none |
content | internal_ContentArray | false | none | none |
rankingData
"{"rankingType":"01","capacity":10,"language":"ES","page":0,"total":1000,"date":"05-12-2019 15:55:06.0","symbol":"€","content":[{"companyID":6334608,"webDescription":"wire-technologies","name":"WIRE TECHNOLOGIES","fullName":"WIRE TECHNOLOGIES SL","tradeName":"WITECH","country":"ESPAÑA","province":"BARCELONA","locality":"GRANOLLERS","rankingValue":" 1.497.900.320.000,00"},{"companyID":6743430,"webDescription":"artesanos-de-la-madera-de-toledo","name":"ARTESANOS DE LA MADERA DE TOLEDO","fullName":"ARTESANOS DE LA MADERA DE TOLEDO SLL","tradeName":"AMT","country":"ESPAÑA","province":"TOLEDO","locality":"VILLACAÑAS","rankingValue":" 957.633.590.000,00"},{"companyID":141417,"webDescription":"ifco-systems-espana","name":"IFCO SYSTEMS ESPAÑA","fullName":"IFCO SYSTEMS ESPAÑA SL","country":"ESPAÑA","province":"VALENCIA","locality":"PICASSENT","rankingValue":" 141.083.509.000,00"},{"companyID":3998567,"webDescription":"antonio-guillin-luana-y-rogelio-dono-pampin","name":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN","fullName":"ANTONIO GUILLIN LUAÑA Y ROGELIO DONO PAMPIN Sociedad Civil","country":"ESPAÑA","province":"CORUÑA (A)","locality":"OLEIROS","rankingValue":" 135.000.135.000,00"},{"companyID":6213959,"webDescription":"suministros-industriales-mahofri","name":"SUMINISTROS INDUSTRIALES MAHOFRI","fullName":"SUMINISTROS INDUSTRIALES MAHOFRI SL","country":"ESPAÑA","province":"ALICANTE","locality":"ELCHE","rankingValue":" 61.411.530.000,00"},{"companyID":1994945,"webDescription":"metalab-2010","name":"METALAB 2010","fullName":"METALAB 2010 SL","country":"ESPAÑA","province":"MADRID","locality":"POZUELO DE ALARCON","rankingValue":" 33.000.000.000,00"},{"companyID":6532265,"webDescription":"taoufik-bahdaoui","name":"TAOUFIK BAHDAOUI","fullName":"TAOUFIK BAHDAOUI","tradeName":"LA TIENDA CHOLLOS","country":"ESPAÑA","province":"CIUDAD REAL","locality":"DAIMIEL","rankingValue":" 28.851.326.680,00"},{"companyID":611505,"webDescription":"autocares-carrasco","name":"AUTOCARES CARRASCO","fullName":"AUTOCARES CARRASCO SL","country":"ESPAÑA","province":"MALAGA","locality":"CAMPILLOS","rankingValue":" 28.851.326.680,00"},{"companyID":63770,"webDescription":"mercadona","name":"MERCADONA","fullName":"MERCADONA SA","country":"ESPAÑA","province":"VALENCIA","locality":"TAVERNES BLANQUES","rankingValue":" 19.059.157.000,00"},{"companyID":2265953,"webDescription":"repsol-petroleo","name":"REPSOL PETROLEO","fullName":"REPSOL PETROLEO SA","tradeName":"REPSOL","country":"ESPAÑA","province":"MADRID","locality":"MADRID","rankingValue":" 18.344.171.000,00"}]}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
rankingType | string | false | none | none |
capacity | number | false | none | none |
language | string | false | none | none |
page | number | false | none | none |
total | number | false | none | none |
date | string | false | none | none |
symbol | string | false | none | none |
content | [object] | false | none | none |
companyID | number | false | none | none |
webDescription | string | false | none | none |
name | string | false | none | none |
fullName | string | false | none | none |
tradeName | string | false | none | none |
country | string | false | none | none |
province | string | false | none | none |
locality | string | false | none | none |
rankingValue | string | false | none | none |
rankings
"[{"rankingID":"01","description":"Ventas","units":"Euros","order":"desc","limit":1000},{"rankingID":"02","description":"Número de Empleados","units":"Unidades","order":"desc","limit":1500},{"rankingID":"03","description":"Fecha de Constitución","units":"Fecha","order":"desc","limit":1000}]"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [ranking] | false | none | none |
ranking
"{"rankingID":"01","description":"Ventas","units":"Euros","order":"desc","limit":1000}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
rankingID | string | false | none | none |
description | string | false | none | none |
units | string | false | none | none |
order | string | false | none | none |
limit | number | false | none | none |
internal_Content
"{"firmId":63770,"webDescription":"mercadona","name":"MERCADONA","fullName":"MERCADONA SA","tradeName":"MERCADONA","country":"ESPAÑA","province":"VALENCIA","locality":"TAVERNES BLANQUES","rankingValue":" 23.343.778.000,00"}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
firmId | number | false | none | none |
webDescription | string | false | none | none |
name | string | false | none | none |
fullName | string | false | none | none |
tradeName | string | false | none | none |
country | string | false | none | none |
province | string | false | none | none |
locality | string | false | none | none |
rankingValue | string | false | none | none |
internal_ContentArray
[
"{"firmId":63770,"webDescription":"mercadona","name":"MERCADONA","fullName":"MERCADONA SA","tradeName":"MERCADONA","country":"ESPAÑA","province":"VALENCIA","locality":"TAVERNES BLANQUES","rankingValue":" 23.343.778.000,00"}"
]
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [internal_Content] | false | none | none |