HBSA Public
  1. Pesagem
HBSA Public
  • Hidrovias do Brasil APIs
  • Autenticação
    • Introdução
    • Client Credentials
    • API Key
    • Gerando token client_credentials
      POST
  • WebSockets
    • Introdução
    • Navigation
      • Tracker
      • Hydrometric Stations
  • REST
    • Navigation
      • Hydrometric Stations
        • Stations
          • Get all sensors data by Filter
          • Get all stations
    • Integrações Externas
      • Pesagem
        • Introdução
        • Adiciona ou atualiza os dados de pesagem
          POST
  • GraphQL
    • Introdução
    • Relatórios
      • Introdução
      • Grãos
        • Estoque
        • Exemplo de execução
      • Fertilizantes
        • Expedição Rodoviária
  • Esquemas
    • Schemas
      • ErrorDetail
      • AssetEntity
      • HttpError
      • BaseEntity
      • StationSensorsDto
      • NotifySubscribersRequest
      • CancelScheduleRequest
      • StationSensorsDtoBooleanPagination
      • NotifySubscribersStation
      • ClientContractEntity
      • StationDto
      • ClientDto
      • ClientDtoBooleanPagination
      • ClientEntity
      • StationTypes
      • ClientImportsForServiceOrderHydroDto
      • CommonEntity
      • ContractEntity
      • ConvoyEntity
      • CountriesDto
      • CountriesDtoBooleanPagination
      • CountryEntity
      • CreateConvoyRequest
      • CreateConvoyResponse
      • CreateLoadOpsShiftRequest
      • CreateLoadOpsShiftResponse
      • CreateServiceOrderHydroClientImportRequest
      • CreateServiceOrderHydroClientImportResponse
      • CreateServiceOrderHydroClientRequest
      • CreateServiceOrderHydroClientResponse
      • CreateServiceOrderHydroLoadOpsRequest
      • CreateServiceOrderHydroLoadOpsResponse
      • CreateServiceOrderHydroResponse
      • CreateServiceOrderHydrosRequest
      • CreateServiceOrderReceptionImportRequest
      • CreateServiceOrderReceptionImportResponse
      • CreateServiceOrderReceptionRequest
      • CreateServiceOrderReceptionResponse
      • CreateServiceOrderRequest
      • CreateServiceOrderResponse
      • CreateServiceOrderRodoLoadImportRequest
      • CreateServiceOrderRodoLoadImportResponse
      • CreateServiceOrderRodoLoadsRequest
      • CreateServiceOrderRodoLoadsResponse
      • CreateServiceOrderRodoRequest
      • CreateServiceOrderRodoResponse
      • CreateShipRequest
      • CreateShipResponse
      • EContractStatus
      • EConvoyStatus
      • EDocumentType
      • EEntityStatus
      • EExternalWeighingIntegrationStatus
      • EFileManagerTags
      • EPierType
      • EProductStatus
      • EProductType
      • ERecintosIntegrationEventType
      • EScheduleProvider
      • EScheduleStatus
      • EServiceOrderHydroStageOps
      • EServiceOrderHydroStatus
      • EServiceOrderReceptionImportCodeImportType
      • EServiceOrderReceptionImportOperation
      • EServiceOrderReceptionImportStatus
      • EServiceOrderReceptionStage
      • EServiceOrderReceptionStatus
      • EServiceOrderRodoStatus
      • EServiceOrderType
      • ESiscomexIntegrationEventType
      • ESiscomexIntegrationStatus
      • ExternalWeighingIntegrationEntity
      • FileResponseDto
      • GetAllAssetsByCriteriasDto
      • GetAllAssetsByCriteriasDtoBooleanPagination
      • GetAllContractByCriteriasDto
      • GetAllContractByCriteriasDtoBooleanPagination
      • GetAllLoadOpsShiftsResponse
      • GetAllLoadOpsShiftsResponseBooleanPagination
      • GetAllOperatingUnitPiersDto
      • GetAllOperatingUnitPiersDtoBooleanPagination
      • GetAllOperatingUnitsDto
      • GetAllOperatingUnitsDtoBooleanPagination
      • GetAllRecintosShipIntegrationLogsResponse
      • GetAllRecintosShipIntegrationLogsResponseBooleanPagination
      • GetAllScheduleHeaderResponse
      • GetAllScheduleListResponse
      • GetAllScheduleListResponseBooleanPagination
      • GetAllScheduleResponse
      • GetAllServiceOrderRodoDetailsResponse
      • GetAllServiceOrderRodoHeaderResponse
      • GetAllServiceOrderRodoListResponse
      • GetAllServiceOrderRodoListResponseBooleanPagination
      • GetAllServiceOrderRodoResponse
      • GetAllSiscomexIntegrationLogsResponse
      • GetAvailableShipsByCriteriasDto
      • GetConvoyBaseResponse
      • GetConvoyByIdResponse
      • GetConvoyCompositionByIdAssociatedBargeDto
      • GetConvoyCompositionByIdBargeBaseDto
      • GetConvoyCompositionByIdBargeClientDto
      • GetConvoyCompositionByIdConvoyDetailsDto
      • GetConvoyCompositionByIdResponse
      • GetLoadOpsShiftByIdResponse
      • GetProductsByCriteria
      • GetProductsByCriteriaBooleanPagination
      • GetRecintosShipIntegrationLogByIdResponse
      • GetScheduleByIdResponse
      • GetServiceOrderHydroByIdClientResponse
      • GetServiceOrderHydroByIdResponse
      • GetServiceOrderHydroClientImportByIdResponse
      • GetServiceOrderHydrosDto
      • GetServiceOrderHydrosDtoBooleanPagination
      • GetServiceOrderReceptionByIdResponse
      • GetServiceOrderReceptionImportByIdResponse
      • GetServiceOrderReceptionImportsDto
      • GetServiceOrderReceptionImportsDtoBooleanPagination
      • GetServiceOrderRodoByIdResponse
      • GetServiceOrderRodoLoadByIdResponse
      • GetServiceOrderRodoLoadImportByIdResponse
      • GetSiscomexIntegrationByIdResponse
      • HeaderResponse
      • HttpValidationProblemDetails
      • ListAllConvoysResponse
      • ListAllConvoysResponseBooleanPagination
      • ListAllExternalWeighingsResponse
      • ListAllExternalWeighingsResponseBooleanPagination
      • ListAllLoadImportsForServiceOrderRodoResponse
      • ListAllLoadsForServiceOrderRodoResponse
      • ListAllRawAssetsDto
      • ListAllRawCountriesResponse
      • ListAllServiceOrderReceptionsDto
      • ListAllServiceOrderReceptionsDtoBooleanPagination
      • ListAllServiceOrdersDto
      • ListAllServiceOrdersDtoBooleanPagination
      • ListAllSiscomexIntegrationsResponse
      • ListAllSiscomexIntegrationsResponseBooleanPagination
      • ListAvailableClientsForServiceOrderHydroResponse
      • ListAvailableForServiceOrderRodoResponse
      • ListAvailableHydroClientImportsForRodoResponse
      • ListAvailableShipsForServiceOrderHydroResponse
      • ListClientImportsForServiceOrderHydroResponse
      • ListLoadChargingForServiceOrderRodoResponse
      • ListLoadImportsForServiceOrderRodo
      • ListLoadOpsForServiceOrderHydroEntriesResponse
      • ListLoadOpsForServiceOrderHydroResponse
      • ListLoadsForServiceOrderRodo
      • ListSuggestedClientImportsForServiceOrderHydroResponse
      • LoadOpsShiftEntity
      • OperatingUnitEntity
      • OperatingUnitPierEntity
      • PatchConvoyRequest
      • PatchLoadOpsShiftRequest
      • PatchPusherRequest
      • PatchServiceOrderHydroClientImportRequest
      • PatchServiceOrderHydroClientRequest
      • PatchServiceOrderHydroCteRequest
      • PatchServiceOrderHydroLoadOpsRequest
      • PatchServiceOrderHydroRequest
      • PatchServiceOrderHydroStageOpsRequest
      • PatchServiceOrderHydroStatusRequest
      • PatchServiceOrderReceptionImportRequest
      • PatchServiceOrderReceptionRequest
      • PatchServiceOrderRodoLoadByIdRequest
      • PatchServiceOrderRodoStatusRequest
      • PatchShipRequest
      • ProblemDetails
      • ProductEntity
      • RecintosShipIntegrationLogEntity
      • ScheduleEntity
      • ServiceOrderEntity
      • ServiceOrderHydroClientEntity
      • ServiceOrderHydroClientImportEntity
      • ServiceOrderHydroClientImportRequest
      • ServiceOrderHydroEntity
      • ServiceOrderHydroLoadOpsDto
      • ServiceOrderHydroLoadOpsEntity
      • ServiceOrderReceptionEntity
      • ServiceOrderReceptionImportEntity
      • ServiceOrderRodoEntity
      • ServiceOrderRodoLoadEntity
      • ServiceOrderRodoLoadImportEntity
      • ShipDto
      • ShipDtoBooleanPagination
      • ShipEntity
      • SiscomexIntegrationEntity
      • SiscomexIntegrationLogEntity
      • TransporterEntity
      • TruckDriverEntity
      • TruckEntity
      • UpdateServiceOrderReceptionDatesRequest
      • UpdateServiceOrderRodoLoadImportByIdRequest
      • UpsertExternalWeighingRequest
      • UpsertExternalWeighingResponse
  1. Pesagem

Introdução

Esse serviço disponibiliza a integração de pesagem rodoviária para parceiros.

Urls#

AmbienteAPI Url
qahttps://apis.qa01.hbsa.com.br/external-integrations/v1/rodo-weighings
prodhttps://apis.hbsa.com.br/external-integrations/v1/rodo-weighings

Autenticação#

Um token Bearer é exigido para consumo do serviço, cada parceiro consumirá somente sesus dados. Veja a documentação sobre autenticação para maiores informações.
O token deve ser enviado no header Authorization.

Tenants#

Para identificar a operação é necessário enviar o identificador da operação no header x-tenant. Os possíveis valores são: op01
op01 Identificada a operação de Fertilizantes

Exemplo de request#

{
    "externalId": 1,
    "licensePlate": "string", // PLAC-123 ou PLAC123, será removido o hífen, caso campo tenha mais que 7 dígitos, resulta no registro com status ErrorInvalidLicensePlate. Caso não exista agendamento com essa placa, resulta no registro com status RodoNotFound
    "initialDate": "string", // "YYYY-MM-DDThh:mm:ss-0000", Exemplo "2025-02-18T12:00:00-0300", caso inválido, resulta no registro com status ErrorInvalidDate
    "finalDate": "string", // "YYYY-MM-DDThh:mm:ss-0000". Deve ser maior que o do campo "InitialDate" Exemplo "2025-02-18T13:00:00-0300", caso inválido, result no registro com status ErrorInvalidDate
    "tareWeightKg": 10, // O valor deve ser maior que zero, resulta no registro com status ErrorInvalidTareWeight
    "grossWeightKg": 11, // O valor deve ser maior que zero e maior que o do campo "tareWeightKg", resulta no registro com status ErrorInvalidGrossWeight
    "truckDriverName": "string",
    "truckDriverCpf": "string",
    "clientName": "string",
    "clientDocument": "string",
    "transporterName": "string",
    "transporterDocument": "string",
    "productDescription": "string"
}
Modificado em 2025-02-18 14:03:47
Página anterior
Get all stations
Próxima página
Adiciona ou atualiza os dados de pesagem
Built with