ShippingApiAccessInterface.php 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\ViewModel\DataProvider;
  6. /**
  7. * API Access Provider Interface
  8. *
  9. * @package Temando\Shipping\ViewModel
  10. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  11. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  12. * @link http://www.temando.com/
  13. */
  14. interface ShippingApiAccessInterface
  15. {
  16. /**
  17. * Obtain Endpoint for Temando REST API access.
  18. *
  19. * @return string
  20. */
  21. public function getApiEndpoint(): string;
  22. /**
  23. * Obtain Session Token for Temando REST API access and set it if necessary.
  24. *
  25. * @return string
  26. */
  27. public function getSessionToken(): string;
  28. /**
  29. * Obtain Session Token Expiry for Temando REST API access.
  30. *
  31. * @return string
  32. */
  33. public function getSessionTokenExpiry(): string;
  34. /**
  35. * Obtain Session Token Retrieval Endpoint
  36. *
  37. * @return string
  38. */
  39. public function getSessionTokenRefreshEndpoint(): string;
  40. }