What is COSTDRIVERS API?
It is a means of "integration" that connects applications and can be used for companies' most varied types of business in different market niches.
The purpose of this documentation is to guide the developer on how to integrate their platform with the COSTDRIVERS API, describing the available services with request and response examples. The possibilities made available by the use of APIs allow software and application developers to connect through different technologies, with different databases, for example. In addition, it is possible to make features and tools specific to certain applications to be used in others without much effort.
Who can use the COSTDRIVERS API?
You must be a COSTDRIVERS subscriber and in the package that allows access to our APIs.
Main benefits
The COSTDRIVERS API solution was developed with REST technology, which is a market standard and is independent of the technology used by our customers. As a result, it is possible to integrate using the most varied programming languages, such as ASP, ASP.Net, Java, PHP, Ruby, and Python. And even integrate with any Business Intelligence (BI) platform or enterprise resource planning (ERP) type software.
Get to know some of the attributes that stand out in theCOSTDRIVERS API platform:
No proprietary apps: no need to install apps under any circumstances.
Simplicity: the protocol used is purely HTTPS.
Credentials: the client's credentials (user credentials and access key) travel in the HTTP request header.
Security: the exchange of information within a totally secure environment and with encrypted information.
Integration Architecture
The model used in the integration of APIs is simple and is based on the use of URLs:
• Transactional URL - specific to operations such as getting token.
• Query URL - for consultative operations such as a list of Indicators.
In the transactional URL to obtain the token, the access credentials "user data" and "access key" must be informed, which must be sent in the header of the request.
Upon the return of the successful operation in obtaining the token, must add the token again in the request header (header) and the parameters required by the query.
How does the consumption of methods with authentication via COSTDRIVERS API work?
The process of consuming methods via COSTDRIVERS API takes place in two stages:
- Step 1: Authentication
- Step 2: Consumption
The flow below outlines the steps at a high level:
- The Client requests authentication in the API, informing username, password, and an Origin Header.
- The API validates access and returns a token with a validity of 5 seconds. (for Security reasons)
- The Client consumes the API method, informing the authentication token, in the Request Header.
Authentication
Getting an Access Token
The solution comprises the step of requesting access token via API and requesting authentication via Java Script.
Environment | Endpoint |
---|---|
PRODUCTION | https://api.costdrivers.com |
Request
{
"username":"usuario@domain.com",
"password": "xxxxxx",
"grant_type": "password"
}
Header | Description | Required |
---|---|---|
Origin | Unique key for client access (without a valid key it is not possible to obtain an authentication token) | Yes |
Filed | Description | Required |
---|---|---|
username | User's email | Yes |
password | User's password | Yes |
grant_type | Fixed "password" | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field type |
---|---|---|
access_token | Token required to perform authentication | String |
token_type | Fixed "bearer" | String |
expires_in | Token duration in seconds | Int |
.issued | Token issue date | String |
.expires | Token expiration date | String |
Indicadores
Methods related to indicators. After authentication, it undergoes the consumption process through the Bearer Authentication standard.
IndicatorsViewList
The method that returns a list of filterable Indicators
Request
Header | Description |
---|---|
Authorization | Bearer Token that was introduced through API authentication |
Field | Description | Required |
---|---|---|
ID | Filter by Indicator ID | No |
Language | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
Indicator | Filter by Indicator name | No |
Source | Filter by source name | No |
Country | Filter by indicator country name | No |
HSCode | Filter by Ncm of the indicator | No |
Group | Filter by indicator group | No |
IDsOut | Indicator IDs not to be listed | No |
IndicatorType | Indicator Type (Ex: "COSTDRIVERS") | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field type |
---|---|---|
ID | Indicator ID | Int |
Indicator | Indicator name | String |
HSCode | Indicator HSCode | String |
Source | Indicator Source | String |
Country | Indicator coutry | String |
Initials | Indicator country abbreviation | String |
Group | Indicator group | String |
IE | Import / Export | String |
IndicatorsViewMonthlyData
The method that returns a list of indicators and their monthly data, with the possibility of filtering
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
Language | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
Ids | All ids that were selected, separated by comma | Yes |
Currency | selected currency | Yes |
StartDate | Search start date "MM/dd/yyyy" | Yes |
EndDate | End date of research "MM/dd/yyyy" | Yes |
Correlation | A boolean true or false sets whether the method should return correlation data | Yes |
Base100 | A boolean true or false, defines whether the method should return data from base 100 | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field type |
---|---|---|
Indicators >> | List of indicators that were selected, with their attributes and data to generate the charts. | Object |
Indicator | Indicator name | String |
Source | Indicator source | String |
Type | Chart type | String |
Initials_1 | Acronym of the country of the line of axis 1, in this case, the line with the original values of the country | String |
Initials_2 | Acronym for the country of the axis line 2, in this case the exchange line | String |
Variation_1 | Axis 1 variation information | String |
Variation_2 | Axis 2 Variation Information | String |
Unit_1 | Axis unit 1 | String |
Unit_2 | Axis unit 2 | String |
ID | Indicator ID | String |
ImportExport | Import, Export or no classified | String |
CountryID | Country ID | String |
StartProjectionDTMK | Projection start date, if any and prepared by Datamark "MM/dd/yyyy" | String |
StartProjectionThirdParty | Projection start date, if any and by third parties "MM/dd/yyyy" | String |
Series_1 >> | A Date/Value list to feed the 1 axis points into the graph. ValueBase100 represents the Value in Base 100 and can be used to build comparative charts between indicators. | Object |
> Date | Date | String |
> Value | Value | Decimal |
> ValueBase100 | Value | Decimal |
Series_2 >> | A date/value list to feed the 2 axis points into the graph. ValueBase100 attribute for axis 2 does not apply. | Object |
> Date | Date | String |
> Value | Value | Decimal |
> ValueBase100 | Value | Decimal |
Correlation >> | > Correlação entre os indicadores selecionados em dados percentuais | Object |
> DateMin | Minimum date of correlation between indicators, where it was possible to form a matrix between them "MM/dd/yyyy" | String |
> DateMax | Maximum date of correlation between indicators, where it was possible to form a matrix between them "MM/dd/yyyy" | String |
> LstCorrelation >> | A list of correlation between 2 indicators, displaying the percentage of correlation between them | Object |
> IDTarget | Date | String |
> TargetIndicator | Value | String |
> IDCovariable | Value | String |
> CovariableIndicator | Date | String |
> Correlation | Value | Decimal |
IndicatorsViewDetails
Método que retorna os detalhes do indicador selecionado: informações, comex, landed price e notícias
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
ID | Indicator ID | Yes |
Language | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
StartDate | Search start date "MM/dd/yyyy" | Yes |
EndDate | Data final da pesquisa "MM/dd/yyyy" | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
IndicatorComex >> | Returns data referring to Comex | Object |
Indicator | Indicator name | String |
HSCode | Common nomenclature of the indicator | String |
Share >> | A list of Import and Export Shares over the years | Object |
> Year | Date | String |
> FOB | Value | Decimal |
> Weight | Value | Decimal |
> IE | Date | String |
Prices >> | A list of Import and Export Prices, with monthly data by country | Object |
> Country | Date | String |
> Date | Value | String |
> FOB | Value | Decimal |
> Weight | Date | Decimal |
> Price | Date | Decimal |
> ExchangePrice | Value | Decimal |
> IE | Value | String |
IndicatorLandedPrice >> | Returns data referring to Landed Price | Object |
Date | Query start date "MM/dd/yyyy" | String |
yl | II value | Decimal |
IPI | IPI value | Decimal |
Pis | PIS value | Decimal |
COFINS | COFINS value | Decimal |
ICMS | ICMS amount | Decimal |
MonthlyDate >> | A list of monthly landed price data, with the attributes below | Object |
> ID | Date | String |
> Date | Value | String |
> CIF | Value | Decimal |
> Landed | Date | Decimal |
> ExchangeCif | Date | Decimal |
> ExchangeLanded | Value | Decimal |
> Base | Value | Int |
News >> | Returns a list of news from the last few months related to the indicator | Object |
> IDNews | news id | Int |
> Title | news headline | String |
> Resume | News Summary | String |
> Date | Date of the news, in "MM/dd/yyyy" format | String |
> Source | News source | String |
> Full | Full story of the news | String |
> Link | News link | String |
Information >> | Returns a list of news from the last few months related to the indicator | Object |
> ID | Indicator ID | Int |
> Indicator | Indicator name | String |
> ValidationReliabilityLevel | Degree of Reliability of the Projection | String |
> ValidationCalculationDate | Calculation Date "MM/dd/yyyy" | String |
> ValidationStartDate | Data inicial do período "MM/dd/yyyy" | String |
> ValidationEndDate | Data final do período "MM/dd/yyyy" | String |
> ValidationText | Explanatory text on validation | String |
ValidationData >> | Returns data to generate the forecast validation graph for the last 12 months. | Object |
> Realized >> | A list of Danbspte/Value to feed the data row performed in the chart. | Object |
> Date | .... | String |
> Value | .... | Decimal |
> Projection >> | A Date/Value list to feed the projected data row into the chart. | Object |
> Date | .... | String |
> Value | .... | Decimal |
> UCL | A Date/Value list to feed the control limits (upper) line into the graph. | Object |
> Date | .... | String |
> Value | .... | Decimal |
> LCL | A Date/Value list to feed the control limits (bottom) row into the graph. | Object |
> Date | .... | String |
> Value | .... | Decimal |
ProjectionReliabilityLevel | Degree of Reliability of the Projection | String |
ProjectionCalculationDate | Calculation Date "MM/dd/yyyy" | String |
ProjectionStartDate | Data inicial do período "MM/dd/yyyy" | String |
ProjectionEndDate | Data final do período "MM/dd/yyyy" | String |
ProjectionText | Explanatory text about the projection | String |
> ProjectionData >> | Returns data to generate the projection chart for the coming months. | Object |
Realized | Not applicable for projection | Null |
> Projection | A Date/Value list to feed the projected data row into the chart. | Object |
> Date | .... | String |
> Value | .... | Decimal |
> UCL | A Date/Value list to feed the control limits (upper) line into the graph. | Object |
> Date | .... | String |
> Value | .... | Decimal |
> LCL | A Date/Value list to feed the control limits (bottom) row into the graph. | Object |
> Date | .... | String |
> Value | .... | Decimal |
Description | Indicator Description | String |
Source | indicator source | String |
DescriptionSource | Source description, with additional data about the source | String |
UpdateFrequence | Update frequency, whether monthly, daily, weekly etc. | String |
WhenUpdate | Best consultation date, according to when it is usually updated | String |
Metodology | Methodology used to obtain the information | String |
AreaCoverage | Geographical Scope | String |
Covariable | Covariates that can relate to the indicator | String |
Note | Projection comment | String |
ExclusiveIndicatorViewMonthlyData
The Method that returns a list of unique Indicators, with the possibility of filtering.
Request
Header | Description |
---|---|
Authorization | Bearer Token that was obtained through API authentication |
Field | Description | Required |
---|---|---|
ExclusiveIndicatorID | Filter by Unique Indicator ID | Not |
StartDate | Period start date | Yes |
EndDate | Period end date | Not |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
ID | Indicator ID | Int |
FileIndicator | Monthly data date | String |
Value | Value | Decimal |
base | Base Value 100 | Int |
Observation | Observation | String |
ExclusiveIndicatorSaveMonthlyData
The Method that changes monthly data for unique indicators.
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field (URL) | Description | Required |
---|---|---|
ID | Indicator identifier | Yes |
LanguageMonthlyData | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
Field (Body) | Description | Field Type |
---|---|---|
ID | Indicator ID | Int |
FileIndicator | Monthly data date | String |
Value | Value | Decimal |
base | Base Value 100 | Int |
Observation | Observation | String |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
Success | True or false | Boolean |
msg | Operation result | String |
Parametrics
Methods related to parametrics.
After authentication, it undergoes the consumption process, through the Bearer Authentication standard.
ParametricEditInternalInflationGet
The Method that returns a list of the internal inflation of the parameter to be edited.
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
KeyDrivers | Parametric identifier (GUID) | Yes |
InflationLanguage | Parametric return language (1 - "PT-BR" , 2 - "EN", 3 - "ES") | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
Currency | Currency | String |
LstInflation >> | A list with monthly values ​​of internal inflation. | Object |
> Date | Data | String |
> Value | Value | Decimal |
LstCurrency >> | List of currencies. | Object |
> IsoCode | Initials | String |
> Currency | Name | String |
ParametricEditInternalInflationPost
The Method that updates the monthly inflation data of the parametric.
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field (URL) | Description | Required |
---|---|---|
KeyDrivers | Parametric identifier (GUID) | Yes |
InflationLanguage | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
Field (Body) | Description | Type |
---|---|---|
LstInflation >> | A list of monthly values ​​of internal inflation. | Object |
> Date | Data | String |
> Value | Value | Decimal |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
Success | True or false | Boolean |
msg | Operation result | String |
ParametricViewList
THe Method that returns a list of Parametrics the user has access to.
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
PageIndex | The home page of the list of parametrics | Yes |
PageSize | The number of items that will be displayed per page (maximum limit of 200 items) | Yes |
Language | Parametric return language (1 - "PT-BR" , 2 - "EN", 3 - "ES") | Yes |
ParametricName | parametric name | Not |
Group | Group's name | Not |
Country | Name of the country | Not |
Not | ||
Editor | Editor's Name | Not |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
ID | parametric id | Int |
Parametric | parametric name | String |
DateUpdate | Last update date of parametric "MM/dd/yyyy" | String |
DateWeighting | "MM/dd/yyyy" parametric weighting date | String |
KeyParametric | "Guid" parameter identifier | String |
UserCreator | Parametric creation user | String |
UserUpdated | Last user who updated the parametric | String |
Group | parametric group | String |
Country | Parameter country | String |
DateMin | Lowest available date of data in parametric "MM/dd/yyyy" | String |
DateMax | Highest available date of data in parametric "MM/dd/yyyy" | String |
ParametricView
The Method that returns a calculated parametric, with data to assemble graphs, with the possibility of filtering.
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
KeyDrivers | Parametric identifier (GUID) | Yes |
Language | Indicator return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
StartDate | Query start date "MM/dd/yyyy" | Yes |
EndDate | End date of the query "MM/dd/yyyy" | Yes |
CurrencyExchange | Moeda ("local" ou "original") | Yes |
Weighting | Weighting ("fixed" or "adjusted") | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
Parametric | parametric name | String |
CalculationDate | Last date of calculation of parametric "MM/dd/yyyy" | String |
StartCalculationDate | Start date used in "MM/dd/yyyy" calculation | String |
EndCalculationDate | End date used in "MM/dd/yyyy" calculation | String |
StartRequestedDate | Start date used in current request "MM/dd/yyyy" | String |
EndRequestedDate | End date used in current request "MM/dd/yyyy" | String |
StatusRequest | Request status, reporting possible errors | String |
ParametricGraphics >> | List of graphs in parametric | Object |
Title | The title of the chart, to be displayed | String |
ID | The ID of the chart indicator (applies only when the chart is Indicator type) | String |
Indicator | Indicator name (applies only when the chart is Indicator type) | String |
Unit | Indicator unit (applies only when the chart is Indicator type) | String |
ChartType | Chart Type, this attribute is key to identifying the chart type. | String |
ChartName_1 | Element Name 1 in Chart | String |
ChartName_2 | Element 2 name in the chart | String |
Variation_1 | Percentage change from element 1 for the graph | String |
Variation_2 | Percentage change of element 2 for the graph | String |
StartOriginalDate | Start date of the original data, for the chart, in the format "MM/dd/yyyy" | String |
EndOriginalDate | End date of the original data, for the chart, in "MM/dd/yyyy" format | String |
MaxProjectionDate | Maximum available date referring to projected values, for the graph, in the format "MM/dd/yyyy" | String |
StartExchangeDate | Start date of the exchanged data, for the chart, in the format "MM/dd/yyyy" | String |
EndExchangeDate | End date of exchanged data, for the chart, in "MM/dd/yyyy" format | String |
MaxExchangeProjectionDate | Maximum available date referring to exchanged and projected values, for the chart, in the format "MM/dd/yyyy" | String |
Serie_1 >> | A Date/Value list to feed the 1 axis points into the graph. ValueBase100 represents the Value in Base 100 and can be used to build comparative charts between indicators. | Object |
> Date | Data... | String |
> Value | Value... | Decimal |
> ValueBase100 | Value... | Decimal |
> Description | ... | String |
Serie_2 >> | A Date/Value list to feed the 1 axis points into the graph. ValueBase100 represents the Value in Base 100 and can be used to build comparative charts between indicators. | Object |
> Date | Data... | String |
> Value | Value... | Decimal |
> ValueBase100 | Value... | Decimal |
> Description | ... | String |
ComparativeIndicators >> | List of comparative indicators that will be added to the chart | Object |
Indicator | Indicator name | String |
Variation_1 | Percentage change of the comparative indicator for the chart | String |
Serie_1 >> | A Date/Value list to feed a comparative indicator element (row), which will be added to the ChartType graphs: "result of cost breakdown" and "internal inflation". | Object |
> Date | Data... | String |
> Value | Value... | Decimal |
Variation_2 | Percentage change of the comparative indicator for the chart | String |
Serie_2 >> | A Date/Value list to feed a comparative indicator (row) element, which will be added to the ChartType chart: "difference". | Object |
> Date | Data... | String |
> Value | Value... | Decimal |
News
Methods related to news.
After authentication, it undergoes the consumption process, through the Bearer Authentication standard.
NewsViewListByIndicator
The Method that returns a list of news related to an indicator, passing as parameter the indicator ID, the number of last months of news and the language of the news
Request
Header | Description | Required |
---|---|---|
Authorization | Bearer Token that was obtained through API authentication | Sim |
Field | Description | Required |
---|---|---|
IndicatorID | Filter by Indicator ID | Yes |
Quantity Months | Number of recent months of news that we will return | Yes |
Language | News return language (1 - "PT-BR" , 2 - "EN" , 3 - "ES") | Yes |
Response
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
"token_type": "bearer",
"expires_in": "2018-07-23T11:29:32"
}
Field | Description | Field Type |
---|---|---|
IDNews | news id | Int |
Title | news headline | String |
Resume | News Summary | String |
Date | Date of the news, in "MM/dd/yyyy" format | String |
Source | News source | String |
Full | Full story of the news | String |
Link | News link | String |