O que é COSTDRIVERS API?

É um meio de "integração" que conecta aplicações, podendo ser utilizadas para os mais variados tipos de negócio, por empresas de diversos nichos de mercado.

O objetivo desta documentação é orientar o desenvolvedor sobre como integrar sua plataforma com a API da COSTDRIVERS, descrevendo os serviços disponíveis com exemplos de requisição e resposta. As possibilidades disponibilizadas pelo uso das APIs proporcionam para os desenvolvedores de softwares e aplicativos a possibilidade de conectarem através de diversas tecnologias, com diferentes bancos de dados, por exemplo. Além disso, é possível fazer com que funcionalidades e ferramentas específicas de determinados aplicativos sejam utilizadas em outros, sem muito esforço.

Quem pode usar o COSTDRIVERS API?

Obrigatoriamente tem que ser assinante da COSTDRIVERS e no pacote que permite o acesso as nossas APIs.

Principais Benefícios

A solução API COSTDRIVERS foi desenvolvida com a tecnologia REST, que é padrão de mercado e independe da tecnologia utilizada por nossos clientes. Desta forma, é possível integrar-se utilizando as mais variadas linguagens de programação, tais como: ASP, ASP.Net, Java, PHP, Ruby e Python. E ainda integrar em qualquer plataforma de Business Intelligence (BI) ou software do tipo enterprise resource planning (ERP).


Conheça alguns dos atributos que se destacam na plataforma API COSTDRIVERS:


Ausência de aplicativos proprietários: não é necessário instalar aplicativos em nenhuma hipótese.

Simplicidade: o protocolo utilizado é puramente o HTTPS.

Credenciais: as credenciais do cliente (credenciais do usuário e chave de acesso) trafegam no cabeçalho da requisição HTTP.

Segurança: a troca de informações dentro de ambiente totalmente seguro e com as informações criptografadas.

Integração multiplataforma: a integração é realizada através de APIs REST, que permitem a utilização de diferentes aplicações.

Arquitetura da Integração

O modelo empregado na integração das APIs é simples e se baseia na utilização de URLs:

• URL transacional - específica para operações como obtenção de token.
• URL de consulta - para operações consultivas, como uma lista de indicadores.

Na URL transacional para obtenção do token, obrigatoriamente deve ser informado as credenciais de acesso "dados do usuário" e "chave de acesso", que devem ser enviadas no cabeçalho (header) da requisição.

No retorno da operação com sucesso na obtenção do token, deverá ser adicionado novamente no cabeçalho (header) da requisição o token, além dos parâmetros que a consulta assim o exigir.

Como funciona o consumo dos métodos com autenticação via COSTDRIVERS API?

O processo de consumo de métodos via COSTDRIVERS API ocorre em duas etapas:

  1. Etapa 1: Autenticação
  2. Etapa 2: Consumo

O fluxo abaixo descreve as etapas em alto nível:

Fluxo COSTDRIVERS API

  1. O Client solicita a autenticação na API, informando username, password e um Header de Origem.
  2. A API valida o acesso e retorna um token com validade de 5 segundos. (por questões de segurança)
  3. O Client consome o método da API, informando o token de autenticação, no Header da requisição.
Obs.: É importante que o método seja consumido sequencialmente à obtenção do token de acesso, pois a validade do token é de 5 segundos, portanto é necessário obter um novo token de acesso antes de efetuar cada requisição.

Autenticação

Obtendo um Token de Acesso

A solução é composta pelo passo de solicitação de token de acesso via API e solicitação de autenticação via Java Script.

Ambiente Endpoint
PRODUÇÃO https://api.costdrivers.com

Request

{
     "username":"usuario@domain.com",
     "password": "xxxxxx",
     "grant_type": "password"
}
Header Descrição Obrigatório
Origem Chave única para o acesso do client (sem uma chave válida não é possível obter um token de autenticação) Sim
Campo Descrição Obrigatório
username Email do usuário Sim
password Senha de acesso do usuário Sim
grant_type Fixo "password" Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}
Campo Descrição Tipo do Campo
access_token Token necessário para realizar a autenticação String
token_type Fixo "bearer" String
expires_in Duração do token em segundos Int
.issued Data da emissão do token String
.expires Data de expiração do token String

Indicadores

Métodos relacionados aos indicadores.
Após autenticação, submete-se ao processo de consumo, através do padrão Bearer Authentication.

IndicatorsViewList

Método que retorna uma lista de indicadores com possibilidade de filtro

Request

Header Descrição
Authorization Bearer Token que foi obtido através de autenticação na API
Campo Descrição Obrigatório
ID Filtro pelo ID do indicador Não
Language Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
Indicator Filtro pelo nome do indicador Não
Source Filtro pelo nome da fonte Não
Country Filtro pelo nome do país do indicador Não
HSCode Filtro pelo Ncm do indicador Não
Group Filtro pelo grupo do indicador Não
IDsOut IDs dos indicadores a não serem listados Não
IndicatorType Tipo do Indicador (Ex: "COSTDRIVERS") Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}
Campo Descrição Tipo do Campo
ID ID do indicador Int
Indicator Nome do indicador String
HSCode Ncm do indicador String
Source Fonte do indicador String
Country País do indicador String
Initials Sigla do país do indicador String
Group Grupo do indicador String
IE Import / Export String

IndicatorsViewMonthlyData

Método que retorna uma lista de indicadores e seus dados mensais, com possibilidade de filtro

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
Language Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
Ids Todos os ids que foram selecionado, separados por vírgula Sim
Currency Moeda selecionada Sim
StartDate Data inicial da pesquisa "MM/dd/yyyy" Sim
EndDate Data final da pesquisa "MM/dd/yyyy" Sim
Correlation Um boolean true or false, define se o método deverá retornar dados da correlação Sim
Base100 Um boolean true or false, define se o método deverá retornar dados da base 100 Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
Indicators >> Lista de indicadores que foram selecionados, com seus atributos e dados para geração dos gráficos Object
Indicator Nome do indicador String
Source Fonte do indicador String
Type Tipo de gráfico String
Initials_1 Sigla do país da linha do eixo 1, nesse caso a linha com os valores originais do país String
Initials_2 Sigla do país da linha do eixo 2, nesse caso a linha de cambiamento String
Variation_1 Informações de variação do eixo 1 String
Variation_2 Informações de variação do eixo 2 String
Unit_1 Unidade do eixo 1 String
Unit_2 Unidade do eixo 2 String
ID ID do indicador String
ImportExport Import, Export ou Sem classificação String
CountryID ID do país String
StartProjectionDTMK Data inicial da projeção, quando houver e for elaborada pela Datamark "MM/dd/yyyy" String
StartProjectionThirdParty Data inicial da projeção, quando houver e for de terceiros "MM/dd/yyyy" String
Series_1 >> Uma lista de Date/Value para alimentar os pontos do eixo 1 no gráfico. O ValueBase100 representa o Valor na Base 100 e pode ser utilizado para construir gráficos comparativos entre os indicadores. Object
    > Date Data... String
    > Value Valor... Decimal
    > ValueBase100 Valor... Decimal
Series_2 >> Uma lista de Date/Value para alimentar os pontos do eixo 2 no gráfico. O atributo ValueBase100 para o eixo 2, não se aplica. Object
    > Date Data... String
    > Value Valor... Decimal
    > ValueBase100 Valor... Decimal
Correlation >> > Correlação entre os indicadores selecionados em dados percentuais Object
    > DateMin Data Mínima da correlação entre os indicadores, onde foi possível formar um matrix entre eles "MM/dd/yyyy" String
    > DateMax Data Máxima da correlação entre os indicadores, onde foi possível formar um matrix entre eles "MM/dd/yyyy" String
    > LstCorrelation >> Uma lista de correlação entre 2 indicadores, exibindo o percentual de correlação entre eles Object
       > IDTarget Data... String
       > TargetIndicator Valor... String
       > IDCovariable Valor... String
       > CovariableIndicator Data... String
       > Correlation Valor... Decimal

IndicatorsViewDetails

Método que retorna os detalhes do indicador selecionado: informações, comex, landed price e notícias

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
ID ID do indicador Sim
Language Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
StartDate Data inicial da pesquisa "MM/dd/yyyy" Sim
EndDate Data final da pesquisa "MM/dd/yyyy" Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
IndicatorComex >> Retorna os dados referentes ao Comex Object
Indicator Nome do indicador String
HSCode Nomenclatura comum do indicador String
Share >> Uma lista de Share de importação e exportação, durante os anos Object
     > Year Data... String
     > FOB Valor... Decimal
     > Weight Valor... Decimal
     > IE Data... String
Prices >> Uma lista de Prices de importação e exportação, com dados mensais por país Object
     > Country Data... String
     > Date Valor... String
     > FOB Valor... Decimal
     > Weight Data... Decimal
     > Price Data... Decimal
     > ExchangePrice Valor... Decimal
     > IE Valor... String
IndicatorLandedPrice >> Retorna os dados referentes ao Landed Price Object
Date Data inicial da consulta "MM/dd/yyyy" String
II Valor do II Decimal
IPI Valor do IPI Decimal
PIS Valor do PIS Decimal
COFINS Valor do COFINS Decimal
ICMS Valor do ICMS Decimal
MonthlyDate >> Uma lista dos dados mensais de landed price, com os atributos abaixo Object
     > ID Data... String
     > Date Valor... String
     > CIF Valor... Decimal
     > Landed Data... Decimal
     > ExchangeCif Data... Decimal
     > ExchangeLanded Valor... Decimal
     > Base Valor... Int
News >> Retorna uma lista de notícias dos últimos meses, relacionadas ao indicador Object
     > IDNews ID da notícia Int
     > Title Título da notícia String
     > Resume Resumo da notícia String
     > Date Data da notícia, no formato "MM/dd/yyyy" String
     > Source Fonte da notícia String
     > Full Matéria completa da notícia String
     > Link Link da notícia String
Information >> Retorna uma lista de notícias dos últimos meses, relacionadas ao indicador Object
     > ID ID do indicador Int
     > Indicator Nome do indicador String
     > ValidationReliabilityLevel Grau de confiabilidade da projeção String
     > ValidationCalculationDate Data de Cálculo "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 Texto explicativo sobre a validação String
ValidationData >> Retorna dados para gerar o gráfico de validação da projeção nos últimos 12 meses. Object
      > Realized >> Uma lista de Danbspte/Value para alimentar a linha de dados realizados no gráfico. Object
         > Date .... String
         > Value .... Decimal
      > Projection >> Uma lista de Date/Value para alimentar a linha de dados projetados no gráfico. Object
         > Date .... String
         > Value .... Decimal
      > UCL Uma lista de Date/Value para alimentar a linha de limites de controle (superior) no gráfico. Object
         > Date .... String
         > Value .... Decimal
      > LCL Uma lista de Date/Value para alimentar a linha de limites de controle (inferior) no gráfico. Object
         > Date .... String
         > Value .... Decimal
ProjectionReliabilityLevel Grau de confiabilidade da projeção String
ProjectionCalculationDate Data de Cálculo "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 Texto explicativo sobre a projeção String
      > ProjectionData >> Retorna dados para gerar o gráfico de projeção para os próximos meses. Object
Realized Não se aplica para projeção Null
      > Projection Uma lista de Date/Value para alimentar a linha de dados projetados no gráfico. Object
         > Date .... String
         > Value .... Decimal
      > UCL Uma lista de Date/Value para alimentar a linha de limites de controle (superior) no gráfico. Object
         > Date .... String
         > Value .... Decimal
      > LCL Uma lista de Date/Value para alimentar a linha de limites de controle (inferior) no gráfico. Object
         > Date .... String
         > Value .... Decimal
Description Descrição do indicador String
Source Fonte do indicador String
DescriptionSource Descrição da fonte, com dados adicionais sobre a fonte String
UpdateFrequence Frequência de atualização , se é mensal, diário, semanal etc String
WhenUpdate Melhor data de consulta, de acordo de quando costuma ser atualizado String
Metodology Metodologia utilizada para obter as informações String
AreaCoverage Abrangência Geográfica String
Covariable Covariáveis que podem se relacionar com o indicador String
Note Comentário sobre a projeção String

ExclusiveIndicatorViewMonthlyData

Método que retorna uma lista de indicadores exclusivos, com possibilidade de filtro.

Request

Header Descrição
Authorization Bearer Token que foi obtido através de autenticação na API
Campo Descrição Obrigatório
ExclusiveIndicatorID Filtro pelo ID do indicador exclusivo Não
StartDate Data inicial do período Sim
EndDate Data final do período Não

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}
Campo Descrição Tipo do Campo
ID ID do indicador Int
DateIndicator Data do dado mensal String
Value Valor Decimal
Base Valor de base 100 Int
Observation Observação String

ExclusiveIndicatorSaveMonthlyData

Método que altera os dados mensais dos indicadores exclusivos.

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo (URL) Descrição Obrigatório
ID Identificador do indicador Sim
LanguageMonthlyData Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
Campo (Body) Descrição Tipo do Campo
ID ID do indicador Int
DateIndicator Data do dado mensal String
Value Valor Decimal
Base Valor de base 100 Int
Observation Observação String

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
Success Verdadeiro ou falso Boolean
Msg Resultado da operação String

Paramétricas

Métodos relacionados às paramétricas.
Após autenticação, submete-se ao processo de consumo, através do padrão Bearer Authentication.

ParametricEditInternalInflationGet

Método que retorna uma lista da inflação interna da paramétrica a ser editada.

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
KeyDrivers Identificador da paramétrica (GUID) Sim
InflationLanguage Idioma de retorno da paramétrica (1 - "PT-BR" , 2 - "EN", 3 - "ES") Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
Currency Moeda String
LstInflation >> Uma lista com valores mensais da inflação interna. Object
    > Date Data String
    > Value Valor Decimal
LstCurrency >> Lista de moedas. Object
    > IsoCode Sigla String
    > Currency Nome String

ParametricEditInternalInflationPost

Método que atualiza os dados mensais de inflação interna da paramétrica.

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo (URL) Descrição Obrigatório
KeyDrivers Identificador da paramétrica (GUID) Sim
InflationLanguage Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
Campo (Body) Descrição Tipo
LstInflation >> Uma lista com valores mensais da dainflação interna. Object
    > Date Data String
    > Value Valor Decimal

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
Success Verdadeiro ou falso Boolean
Msg Resultado da operação String

ParametricViewList

Método que retorna uma lista de Paramétricas, que o usuário tem acesso

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
PageIndex A página inicial da lista de paramétricas Sim
PageSize A quantidade de itens que será exibido por página (limite máximo de 200 itens) Sim
Language Idioma de retorno da paramétrica (1 - "PT-BR" , 2 - "EN", 3 - "ES") Sim
ParametricName Nome da paramétrica Não
Group Nome do Grupo Não
Country Nome do País Não
Email Email Não
Editor Nome do Editor Não

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
ID ID da paramétrica Int
Parametric Nome da paramétrica String
DateUpdate Última data de atualização da paramétrica "MM/dd/yyyy" String
DateWeighting Data de ponderação da paramétrica "MM/dd/yyyy" String
KeyParametric "Guid" identificador da paramétrica String
UserCreator Usuário de criação da paramétrica String
UserUpdated Último usuário que atualizou a paramétrica String
Group Grupo da paramétrica String
Country País da paramétrica String
DateMin Menor data disponível de dados na paramétrica "MM/dd/yyyy" String
DateMax Maior data disponível de dados na paramétrica "MM/dd/yyyy" String

ParametricView

Método que retorna uma paramétrica calculada, com dados para montar gráficos, com possibilidade de filtro

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
KeyDrivers Identificador da paramétrica (GUID) Sim
Language Idioma de retorno do indicador (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim
StartDate Data inicial da consulta "MM/dd/yyyy" Sim
EndDate Data final da consulta "MM/dd/yyyy" Sim
CurrencyExchange Moeda ("local" ou "original") Sim
Weighting Ponderação ("fixa" ou "ajustada") Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
Parametric Nome da paramétrica String
CalculationDate Última data de cálculo da paramétrica "MM/dd/yyyy" String
StartCalculationDate Data inicial utilizada no cálculo "MM/dd/yyyy" String
EndCalculationDate Data final utilizada no cálculo "MM/dd/yyyy" String
StartRequestedDate Data inicial utilizada na requisição atual "MM/dd/yyyy" String
EndRequestedDate Data final utilizada na requisição atual "MM/dd/yyyy" String
StatusRequest Status da requisição, informando possíveis erros String
ParametricGraphics >> Lista de gráficos na paramétrica Object
Title O título do gráfico, a ser exibido String
ID O ID do indicador do gráfico (só se aplica quando o gráfico for do tipo Indicator) String
Indicator Nome do indicador (só se aplica quando o gráfico for do tipo Indicator) String
Unit Unidade do indicador (só se aplica quando o gráfico for do tipo Indicator) String
ChartType Tipo do gráfico, este atributo é chave para identificar o tipo do gráfico String
ChartName_1 Nome do elemento 1 no gráfico String
ChartName_2 Nome do elemento 2 no gráfico String
Variation_1 Variação percentual do elemento 1, para o gráfico String
Variation_2 Variação percentual do elemento 2, para o gráfico String
StartOriginalDate Data de início dos dados originais, para o gráfico, no formato "MM/dd/yyyy" String
EndOriginalDate Data final dos dados originais, para o gráfico, no formato "MM/dd/yyyy" String
MaxProjectionDate Data máxima disponível referente a valores projetados, para o gráfico, no formato "MM/dd/yyyy" String
StartExchangeDate Data de início dos dados cambiados, para o gráfico, no formato "MM/dd/yyyy" String
EndExchangeDate Data final dos dados cambiados, para o gráfico, no formato "MM/dd/yyyy" String
MaxExchangeProjectionDate Data máxima disponível referente a valores cambiados e projetados, para o gráfico, no formato "MM/dd/yyyy" String
Serie_1 >> Uma lista de Date/Value para alimentar os pontos do eixo 1 no gráfico. O ValueBase100 representa o Valor na Base 100 e pode ser utilizado para construir gráficos comparativos entre os indicadores. Object
    > Date Data... String
    > Value Valor... Decimal
    > ValueBase100 Valor... Decimal
    > Description ... String
Serie_2 >> Uma lista de Date/Value para alimentar os pontos do eixo 1 no gráfico. O ValueBase100 representa o Valor na Base 100 e pode ser utilizado para construir gráficos comparativos entre os indicadores. Object
    > Date Data... String
    > Value Valor... Decimal
    > ValueBase100 Valor... Decimal
    > Description ... String
ComparativeIndicators >> Lista de indicadores comparativos que serão adicionados os gráfico Object
Indicator Nome do indicador String
Variation_1 Variação percentual do indicador comparativo, para o gráfico String
Serie_1 >> Uma lista de Date/Value para alimentar um elemento (linha) indicador comparativo , que será adicionado nos gráfico de ChartType: "result of cost breakdown" e "internal inflation". Object
    > Date Data... String
    > Value Valor... Decimal
Variation_2 Variação percentual do indicador comparativo, para o gráfico String
Serie_2 >> Uma lista de Date/Value para alimentar um elemento (linha) indicador comparativo , que será adicionado no gráfico de ChartType: "difference". Object
    > Date Data... String
    > Value Valor... Decimal

Notícias

Métodos relacionados as notícias.
Após autenticação, submete-se ao processo de consumo, através do padrão Bearer Authentication.

NewsViewListByIndicator

Método que retorna uma lista de notícias relacionadas com um indicador, passando como parâmetro o ID do indicador, a qtde de últimos meses de notícias e o idioma das notícias

Request

Header Descrição Obrigatório
Authorization Bearer Token que foi obtido através de autenticação na API Sim
Campo Descrição Obrigatório
IndicatorID Filtro pelo ID do indicador Sim
QuantityMonths Quantidade dos últimos meses de notícias que iremos retornar Sim
Language Idioma de retorno das notícias (1 - "PT-BR" , 2 - "EN" , 3 - "ES") Sim

Response

{
      "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfbmFtZSI6IlFBXzNEU19BdXRoZW50aWNhdG9yIiwiY2xpZW50X2lkIjoiZGJhM2E4ZGItZmE1NC00MGUwLThiYWItN2JmYjliNmYyZTJlIiwic2NvcGVzIjoie1wiU2NvcGVcIjpcIjNEU0F1dGhlbnRpY2F0b3JcIixcIkNsYWltc1wiOlt7XCJOYW1lXCI6XCJNZXJjaGFudE5hbWVcIixcIlZhbHVlc1wiOFwiVmFsdWVzXCI6W1wiNTU1NVwiXX0se1wiTmFtZVwiOlwiUmVmZXJlbmNlSWRcIixcIlZhbHVlc1wiOltcImY3MjE1YmQ3LWM0OTQtNGQ5Yi1NzEyfQ.daMqXko3dZOV0TzNFQ2vSsVSKqOsrwuswg7RB82ecAASSSSSSSSSSSSFFFFFFFFFFFFFGGGGGGGGGGGGGGGGGGGGGGGG",
      "token_type": "bearer",
      "expires_in": "2018-07-23T11:29:32"
}

Campo Descrição Tipo do Campo
IDNews ID da notícia Int
Title Título da notícia String
Resume Resumo da notícia String
Date Data da notícia, no formato "MM/dd/yyyy" String
Source Fonte da notícia String
Full Matéria completa da notícia String
Link Link da notícia String