HBSA Public
  1. Autenticação
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
  • 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. Autenticação

Client Credentials

A maioria das APIs da Hidrovias do Brasil vão exigir um token JWT para realizar autenticação

Exemplo de utilização#

INFORMAÇÃO
Os valores client_id e secret são fornecidos através de contato com a Hidrovias
Um exemplo de resposta válida:
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ4LU1aRnUyeE9ROE9hMGNxQlRIVE1uLVc5WVJNUU1Tb3A1REZvU3BRbjZjIn0.eyJleHAiOjE3MjA4MTQ1MTksImlhdCI6MTcyMDgxNDIxOSwianRpIjoiNjY0OTY0NmMtMTgzNS00M2EyLThjYjItMGE4ZTUxMTNlNjE5IiwiaXNzIjoiaHR0cHM6Ly9wbGEtaWRlbnRpdHktc2VydmVyLmRldi5oYnNhLmNvbS5ici9yZWFsbXMvaGJzYS1xYSIsImF1ZCI6ImFjcWEtbmF2aWdhdGlvbi1hcGkiLCJzdWIiOiI2NjM1OWY5OS05YmY5LTQ2NDgtYjcxNC1jYTZkMDY1MmQxYTkiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJkZW1vLWFsZWYiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIi8qIl0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImNsaWVudEhvc3QiOiIxNzIuMjkuMC40IiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtZGVtby1hbGVmIiwiY2xpZW50QWRkcmVzcyI6IjE3Mi4yOS4wLjQiLCJjbGllbnRfaWQiOiJkZW1vLWFsZWYifQ.Oc9fRV2f30sPOaC-Qo3wMt6prBAzKoovlalx-lfj8GQB7Y6Dvcll4FHxBw9ureS0HfSo2hKCOEYSHeBsQ4T-iVYf4SpndDajt8HsJ3NOrNge_iXQg2MxrYDL9DdqISLlW47wvNbm5P0ESB_0x2vhRQvPSur6IUvIMUaoueZukuQ6asY4t_aSvB-XJSNfRTo1ibszjxa3sq9dVkoa33IMj3RcSg44xhsnXu9oQ6E2MSmwa1Ztj2fgxowQvudTKw0krk8_WAS73qusNe58UR4nHNIdJZUfsbislum3qaqEKEhpRoZ7vTDAlE3g3UEMB7vpowozU16L0I-zy2bVKJ-_bA",
    "expires_in": 300,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "profile email"
}
O token é obtido através da propriedade access_token na resposta da chamada

Renovando tokens#

O token tem vida útil, então é importante realizar a renovação para que sua chamadas não sejam rejeitas a partir dessa expiração
Modificado em 2024-09-12 20:23:10
Página anterior
Introdução
Próxima página
API Key
Built with