transport

transport

import "github.com/ronny/ptvapi/transport"

• Overview
• Imported Packages
• Index

Overview

Package transport provides a custom transport that automatically calculates the request signature as required by the PTV Timetable API v3, and includes both the devid and signature query param in all requests to the API.

Example

	// Create a transport that will be wrapped by `SigningTransport`, here
	// we just create a default http transport from the
	// github.com/go-openapi/runtime/client package
	underlyingTransport := httptransport.New(
		apiclient.DefaultHost,
		apiclient.DefaultBasePath,
		apiclient.DefaultSchemes,
	)

	// Wrap the underlying transport and also supply devid and apikey that you
	// get from PTV
	transport := transport.NewSigningTransport(underlyingTransport,
		os.Getenv("DEVID"), os.Getenv("APIKEY"))

	// Create a new `client` (from github.com/ronny/ptvapi/client pkg) with the
	// custom transport
	client := apiclient.New(transport, strfmt.Default)

	// Use `client` as you would normally, without `devid` and `signature` params
	resp, err := client.Routes.RoutesOneOrMoreRoutes(&routes.RoutesOneOrMoreRoutesParams{
		Context: context.Background(),
	})

See examples/get-routes/ for a complete example of how to use this package.

Imported Packages

• github.com/go-openapi/runtime
• github.com/go-openapi/strfmt

Index

• func Signature(apiKey, requestURI string) (string, error)
• type SigningTransport
  • func NewSigningTransport(transport runtime.ClientTransport, devID string, apiKey string) *SigningTransport
  • func (t *SigningTransport) Submit(op *runtime.ClientOperation) (interface{}, error)

Package files

doc.go signature.go transport.go

func Signature

func Signature(apiKey, requestURI string) (string, error)

type SigningTransport

type SigningTransport struct {
    Transport runtime.ClientTransport
    AuthInfo  runtime.ClientAuthInfoWriter
}

SigningTransport wraps another transport (Transport) to automatically add the devid and signature query params to every outgoing request as required by the PTV Timetable API v3.

The signature query param is calculated from the request URI and APIKey.

func NewSigningTransport

func NewSigningTransport(transport runtime.ClientTransport, devID string, apiKey string) *SigningTransport

func (*SigningTransport) Submit

func (t *SigningTransport) Submit(op *runtime.ClientOperation) (interface{}, error)

Generated by godoc2ghmd