Pular para o conteúdo

INFLOR - API de ALIANÇAS (v2)

API destinada a integração de parcerias com a INFLOR.

Baixar descrição da OpenAPI
Contato
URL
Diretoria de Alianças
Linguagens
Ambientes
Qualidade
https://api-alliances.inflor-qas.cloud/api/v2
Produção
https://api-alliances.inflor.cloud/api/v2

Endpoints que fazem interface com o módulo de Colheita do SGF da INFLOR.

Operações

Endpoints de acompanhamento de uso e monitoramento da API.

Operações

Requisição

Segurança
API-Key and Client-Code
curl -i -X GET \
  https://api-alliances.inflor-qas.cloud/api/v2/analytics/data-cubes \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE'

Respostas

Sucesso

Corpoapplication/jsonArray [
idstring
namestring
descriptionstring
]
Resposta
application/json
[ { "id": "string", "name": "string", "description": "string" } ]

Requisição

Segurança
API-Key and Client-Code
Caminho
idstring
curl -i -X GET \
  'https://api-alliances.inflor-qas.cloud/api/v2/analytics/data-cubes/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE'

Respostas

Sucesso

Corpoapplication/json
dataCubestring
clientstring
clientAbbrevstring
dataRequestedOnstring(date-time)
lastDataRefreshstring(date-time)
totalRecordsinteger
datasetArray of objects
Resposta
application/json
{ "dataCube": "string", "client": "string", "clientAbbrev": "string", "dataRequestedOn": "2019-08-24T14:15:22Z", "lastDataRefresh": "2019-08-24T14:15:22Z", "totalRecords": 0, "dataset": [ {} ] }

Obter Relatórios Disponíveis

Requisição

Segurança
API-Key and Client-Code
curl -i -X GET \
  https://api-alliances.inflor-qas.cloud/api/v2/analytics/data-cubes/reports \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE'

Respostas

Sucesso

Corpoapplication/json
dataRequestedOnstring(date-time)
totalReportsinteger
reportsArray of objects
Resposta
application/json
{ "dataRequestedOn": "2019-08-24T14:15:22Z", "totalReports": 0, "reports": [ {} ] }

Requisição

Segurança
API-Key and Client-Code
Caminho
idinteger
Consulta
pageSizeinteger<= 1000
Padrão 100
cursorstring
curl -i -X GET \
  'https://api-alliances.inflor-qas.cloud/api/v2/analytics/data-cubes/reports/{id}?pageSize=100&cursor=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE'

Respostas

Sucesso

Corpoapplication/json
reportIdinteger
dataRequestedOnstring(date-time)
paginationobject
dataArray of objects
Resposta
application/json
{ "reportId": 0, "dataRequestedOn": "2019-08-24T14:15:22Z", "pagination": { "count": 0, "pageSize": 0, "hasNextPage": true, "nextCursor": "string", "previousCursor": "string", "orderBy": [] }, "data": [ {} ] }

Requisição

Segurança
API-Key and Client-Code
Caminho
serviceIdstring
Consulta
layerIdinteger>= 0
Padrão 0
curl -i -X GET \
  'https://api-alliances.inflor-qas.cloud/api/v2/gis/agol/geojson/{serviceId}?layerId=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Client-Code: YOUR_API_KEY_HERE'

Respostas

Sucesso. Retorna um objeto do tipo GeoJSON seguindo a especificação RFC 7946.

Corpoapplication/json
typestringobrigatório
Valor"FeatureCollection"
Discriminador
featuresArray of objects>= 0 itemsobrigatório
features[].​typestringobrigatório
Valor"Feature"
features[].​geometryobject or null
One of:
features[].​propertiesobject or null
features[].​idstring or number
propertiesobject or null
Resposta
application/json
{ "type": "FeatureCollection", "features": [ {} ], "properties": {} }

Endpoints para acompanhamento do processamento e logs das requisições.

Operações