Documentación de Asnef Data

ASNEFDATAApi 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:

• https://$(catalog.host)/asnefdataapi

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__asnefdata_{nif}

Code samples

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)/asnefdataapi/asnefdata/{nif}',

 params: {

 }, headers: headers


p JSON.parse(result)

import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/asnefdataapi/asnefdata/{nif}', headers = headers)


print(r.json())

GET https://$(catalog.host)/asnefdataapi/asnefdata/{nif} HTTP/1.1


Accept: application/json

const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/asnefdataapi/asnefdata/{nif}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});

GET /asnefdata/{nif}

Parameters

Name	In	Type	Required	Description
nif	path	string	true	nif
lang	query	string	false	lang

Example responses

200 Response

"{"message":{"code":"string","description":"string"},"notAvailable":"string","operations":[{"operationSummary":{"creditorType":"string","firstExpirationDate":"2020-03-12T11:47:49.665Z","lastExpirationDate":"2020-03-12T11:47:49.665Z","nominalAmount":0,"numberUnpaidContributions":0,"product":"string","state":"string","unpaidAmount":0},"operationsHistory":[{"date":"2020-03-12T11:47:49.665Z","numberUnpaidContributions":0,"state":"string","unpaidAmount":0}]}],"totals":{"firstAmountDate":"2020-03-12T11:47:49.665Z","lastAmountDate":"2020-03-12T11:47:49.665Z","nominalAmount":0,"unpaidAmount":0,"unpaidContributions":0},"unpaidProgression":[{"amount":0,"date":"2020-03-12T11:47:49.665Z"}],"unpaidSummary":[{"operationsAmount":0,"operationsNumber":0,"situation":"string","year":0}]}"

Responses

Status	Meaning	Description	Schema
200	OK	200 OK	asnefDetails
400	Bad Request	400 Bad Request	responseError
401	Unauthorized	401 Unauthorized	responseError
403	Forbidden	403 Forbidden	responseError
404	Not Found	404 Not Found	responseError
500	Internal Server Error	500 Internal Server Error	responseError

Schemas

asnefDetails

"{"message":{"code":"string","description":"string"},"notAvailable":"string","operations":[{"operationSummary":{"creditorType":"string","firstExpirationDate":"2020-03-12T11:47:49.665Z","lastExpirationDate":"2020-03-12T11:47:49.665Z","nominalAmount":0,"numberUnpaidContributions":0,"product":"string","state":"string","unpaidAmount":0},"operationsHistory":[{"date":"2020-03-12T11:47:49.665Z","numberUnpaidContributions":0,"state":"string","unpaidAmount":0}]}],"totals":{"firstAmountDate":"2020-03-12T11:47:49.665Z","lastAmountDate":"2020-03-12T11:47:49.665Z","nominalAmount":0,"unpaidAmount":0,"unpaidContributions":0},"unpaidProgression":[{"amount":0,"date":"2020-03-12T11:47:49.665Z"}],"unpaidSummary":[{"operationsAmount":0,"operationsNumber":0,"situation":"string","year":0}]}"

Properties

Name	Type	Required	Restrictions	Description
message	object	false	none	none
code	string	false	none	none
description	string	false	none	none
notAvailable	string	false	none	none
operations	[object]	false	none	none
operationSummary	object	false	none	none
creditorType	string	false	none	none
firstExpirationDate	string	false	none	none
lastExpirationDate	string	false	none	none
nominalAmount	number	false	none	none
numberUnpaidContributions	number	false	none	none
product	string	false	none	none
state	string	false	none	none
unpaidAmount	number	false	none	none
operationsHistory	[object]	false	none	none
date	string	false	none	none
numberUnpaidContributions	number	false	none	none
state	string	false	none	none
unpaidAmount	number	false	none	none
totals	object	false	none	none
firstAmountDate	string	false	none	none
lastAmountDate	string	false	none	none
nominalAmount	number	false	none	none
unpaidAmount	number	false	none	none
unpaidContributions	number	false	none	none
unpaidProgression	[object]	false	none	none
amount	number	false	none	none
date	string	false	none	none
unpaidSummary	[object]	false	none	none
operationsAmount	number	false	none	none
operationsNumber	number	false	none	none
situation	string	false	none	none
year	number	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	string	false	none	HttpStatus