2.0info: 1.0.1 Cotação de commodities description: Cotação de commodities x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: commodities contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /commodities/queries/healthcheck: post: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/listCommodities: post: description: Retorna as commodities disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das commodities disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as commodities disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das commodities disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/listInitialPeriod: post: description: Retorna a data inicial disponível para seleção conforme a commodity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – commodity properties: commodity: type: string description: commodity searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período inicial totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a data inicial disponível para seleção conforme a commodity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: commodity description: commodity in: query required: true type: string – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período inicial totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/listFinalPeriod: post: description: Retorna a data final disponível para seleção conforme a commodity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – commodity properties: commodity: type: string description: commodity searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período final totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a data final disponível para seleção conforme a commodity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: commodity description: commodity in: query required: true type: string – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período final totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/priceHistoryByCommodity: post: description: Query para consultar o histórico de preço de commodities tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: commodity: type: array items: type: string description: Commodity initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalytics minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para consultar o histórico de preço de commodities tags: – Queries x-senior-visibility: PRIVATE parameters: – name: commodity description: Commodity in: query type: array items: type: string – name: initialPeriod description: Período inicial in: query type: array items: type: string – name: finalPeriod description: Período final in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalytics minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/listCurrentPrice: post: description: Query para consultar o preço atual da commodity, com a variação de acordo com sua ultima cotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – commodity properties: commodity: type: array items: type: string minimum: 1 description: Commodity responses: 200: description: Ok schema: type: object required: – currentPrice properties: currentPrice: type: array items: type: object allOf: – #/definitions/currentPrice minimum: 1 description: Retorno contendo o preço atual e variações de acordo com sua ultima cotação, em real e porcentagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para consultar o preço atual da commodity, com a variação de acordo com sua ultima cotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: commodity description: Commodity in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – currentPrice properties: currentPrice: type: array items: type: object allOf: – #/definitions/currentPrice minimum: 1 description: Retorno contendo o preço atual e variações de acordo com sua ultima cotação, em real e porcentagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /commodities/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck currentPrice: description: Retorno para o componente de cotação diária type: object required: – priceDate – currentPrice – previousPriceVariationInReais – previousPriceVariationPercentage properties: priceDate: type: string description: Data da cotação currentPrice: type: string description: Preço atual previousPriceVariationInReais: type: number format: double description: Variação em relação a cotação anterior em Reais previousPriceVariationPercentage: type: number format: double description: Variação em relação a cotação anterior em porcentagem projectionAnalytics: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – prices properties: period: type: string description: valores da coluna prices: type: number format: double description: valores da série defaultDataLookup: description: Retorno padrão para lookup de dados type: object required: – id – description properties: id: type: string description: Id description: type: string description: Descrição notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE