CPL API
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
    • Úvod
    • Obecné
    • Tvorba zásilek a objednávek
    • Historie verzí
    • Autentizace
      • Získání Bearer tokenu
    • API Metody
    • Příklady požadavků a odpovědí
      • Vícekusá zásilka
      • Více zásilek v jednom požadavku
      • Zásilka do zahraničí s dobírkou i bez - balíky v sadě
      • Odpověď – vyzvednutí etiket (PDF A4) z GET shipment/batch/{batchId}/label
      • Odpověď – vyzvednutí etiket (ZPL)
      • Odpověď – vyzvednutí etiket (JPG)
      • Spojování zásilek
    • Často kladené otázky
    • Postman kolekce
    • Postman flows
    • Schemas
      • Schemas
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ConnectHierarchyModel
        • AcceptLanguageSchema
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ConnectHierarchyResultModel
        • Eps.Api.MyApi2.Web.Models.Codelist.CountryModel
        • Eps.Api.MyApi2.Web.Models.Codelist.AgeCheckTypeModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentPhaseModel
        • Eps.Api.MyApi2.Web.Models.Routing.RouteModel
        • EmptyNullableObject
        • Eps.Api.Infrastructure.WebApi.Model.InfoModel
        • Eps.Api.Infrastructure.WebApi.Model.ProblemJsonBasicModel
        • Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel
        • Eps.Api.MyApi2.Business.Dto.VersionInformation.VersionInformationDto
        • Eps.Api.MyApi2.Business.Enums.ConstImportState
        • Eps.Api.MyApi2.Business.Enums.ConstPageSize
        • Eps.Api.MyApi2.Business.Enums.ConstRelationType
        • Eps.Api.MyApi2.Business.Enums.ConstReturnChannel
        • Eps.Api.MyApi2.Web.Constants.ConstLabelFormat
        • Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum
        • Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum
        • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointCapacitySettingModel
        • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointModel
        • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointWorkHourModel
        • Eps.Api.MyApi2.Web.Models.AccessPoint.ConstMyApi2AccessPointType
        • Eps.Api.MyApi2.Web.Models.AccessPoint.CoordinatesModel
        • Eps.Api.MyApi2.Web.Models.AddressWhisper.AddressWhispModel
        • Eps.Api.MyApi2.Web.Models.AddressWhisper.CalledFrom
        • Eps.Api.MyApi2.Web.Models.Codelist.CurrencyModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ProofOfIdentityTypeModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ServicePriceLimitModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentExternalNumberTypeModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentProductType
        • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentServiceModel
        • Eps.Api.MyApi2.Web.Models.Codelist.StatusModel
        • Eps.Api.MyApi2.Web.Models.Codelist.ValidationMessageModel
        • Eps.Api.MyApi2.Web.Models.Customer.AccountModel
        • Eps.Api.MyApi2.Web.Models.Customer.AddressModel
        • Eps.Api.MyApi2.Web.Models.Customer.CustomerModel
        • Eps.Api.MyApi2.Web.Models.CustomerAccess.CreateApiAccessModel
        • Eps.Api.MyApi2.Web.Models.CustomerAccess.CreateSandboxAccessModel
        • Eps.Api.MyApi2.Web.Models.CustomerAccess.ResendSandboxUserEmailModel
        • Eps.Api.MyApi2.Web.Models.Enum.OrderStates
        • Eps.Api.MyApi2.Web.Models.Enum.OrderType
        • Eps.Api.MyApi2.Web.Models.Integrator.AddressType
        • Eps.Api.MyApi2.Web.Models.Integrator.CodAccountModel
        • Eps.Api.MyApi2.Web.Models.Integrator.ContactType
        • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerAddressModel
        • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerContactModel
        • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerModel
        • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerAddressModel
        • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerContactModel
        • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerModel
        • Eps.Api.MyApi2.Web.Models.Order.OrderModel
        • Eps.Api.MyApi2.Web.Models.Order.RecipientAddressModel
        • Eps.Api.MyApi2.Web.Models.Order.SenderAddressModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderBatchResultModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderResultItemModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.RecipientAddressModel
        • Eps.Api.MyApi2.Web.Models.OrderBatch.SenderAddressModel
        • Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel
        • Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel
        • Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel
        • Eps.Api.MyApi2.Web.Models.Shipment.RoutingFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates
        • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel
        • Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel
        • Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentBatchResultModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultChildItemModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultItemModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel
        • Eps.Api.MyApi2.Web.Models.ShipmentBatch.WeighedShipmentFeatureModel
        • Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectRecipientAddressModel
        • Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel
        • XCorrelationIdSchema
        • XLogLevelSchema
        • XPagingSchema
    Užitečné odkazy
    Užitečné odkazy
    • Developer
    • Sandbox
    Užitečné odkazy
    Užitečné odkazy
    • Developer
    • Sandbox
    Switch to english

    Autentizace

    CPL API podporuje způsob autentizace založený na Bearer tokenu, využívající protokol OAuth 2.0. Tento typ autentizace poskytuje bezpečný a flexibilní způsob přístupu k chráněným zdrojům API.

    Požadavky na autentizaci#

    Metoda GET/INFO: Tato metoda autentizaci nevyžaduje a lze ji volat bez přihlášení.
    Všechny ostatní metody: Vyžadují HTTP autentizaci pomocí validního Bearer tokenu.
    Pro přístup k API je nutné splnit následující požadavky:
    1. Povolení OAuth 2.0:
    Požádejte podporu CPL o povolení přístupu k OAuth 2.0 a získání klientských údajů (Client ID a Client Secret).
    2. Generování Access Tokenu:
    Přihlaste se ke službě pomocí Client ID a Client Secret.
    Odesílejte žádost na url určené pro vydání tokenů (https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken).

    Bezpečnostní zásady#

    Vzhledem k povaze této autentizace je NUTNÉ používat výhradně protokol HTTPS. To zajistí šifrování komunikace a ochranu citlivých údajů během přenosu.

    Platnost Access Tokenu#

    Access token má omezenou platnost 30 minut.
    Po vypršení platnosti je třeba token obnovit.
    Maximální počet vygenerovaných tokenů je 12 tokenů/min

    Doporučení#

    1.
    Bezpečné ukládání tokenů:
    Access tokeny ani Client Secret by nikdy neměly být uloženy ve zdrojovém kódu nebo veřejně dostupných místech.
    2.
    Automatická obnova tokenu:
    Implementujte mechanismus pro automatické obnovení tokenu před jeho vypršením.
    3.
    Použití HTTPS pro všechny požadavky:
    Nikdy neodesílejte tokeny nebo přihlašovací údaje přes nešifrované připojení (HTTP).

    Časté problémy#

    Neplatný token: Zkontrolujte, zda byl access token správně zahrnut do hlavičky Authorization.
    Vypršení platnosti: Pokud token vypršel, vygenerujte nový.
    Chyby autentizace: Ujistěte se, že používáte správné Client ID a Client Secret.
    Modified at 2025-01-31 11:55:38
    Previous
    Historie verzí
    Next
    Získání Bearer tokenu