SilverCore API python wrapper


Keywords
silvercore, silver, hackpartners, hacktrain, hack, partners
License
Other
Install
pip install silver==0.3.5

Documentation

Silver.py: Rail payments made easy

The friendly open source SilverCore python interface

--

What is silver.py?

A python wrapper for SilverRail's globally renowned SilverCore API. This python wrapper aims to provide a thin layer that abstracts the SOAP and SSL leg-work, and exposes a simple, pythonic interface. It's very simple to get started!

More info at silverrailtech.com!

Installing

    pip install silver

Initialize the SilverClient

In order to initialize the SilverClient, you will require the following variables:

  • distributor (HackTrain)
  • pointOfSale (GB)
  • channel (CH1)
  • SILVERCORE_CERT (Path to your SilverCore Certificate)
  • SILVERCORE_KEY (Path to your SilverCore Key)

Then just run the following command

    from silver import *
    
    cert = os.environ("SILVERCORE_CERT")
    key = os.environ("SILVERCORE_KEY")
    sc = SilverCore("HackTrain", "GB", "CH2", cert, key)
    

Search for available Fares

To start with, you will need to search for available journeys in order to book your trip.

    # Create your passenger - an ID will be generated automatically
    p1 = Passenger(age=30)
    
    tp1 = TravelPoint(
        origin="GBQQU", 
        destination="GBQQM",
        departure=datetime(2015, 11, 16, 12))
    
    fq = FareSearch(
            travel_points = [tp1],
            fare_filter = FARE_FILTER.CHEAPEST,
            passengers = [p1])
    
    fares_result = sc.search_fare(fq)
     
    # You can query the status of the response
    print fares_result.requestStatus # True
    

Create booking

Once you find the requests, you will be able to create a booking by selected the legs that you find most convenient, and its respective fare.

    # Add relevant details for the passengers that were created above
    p1.first_name = "Jane"
    p1.last_name = "Smith"
    p1.add_contact(ContactInfo(CONTACT_TYPE.UNKNOWN, CONTACT_MEDIUM.PHONE, "123456789"))
    p1.add_contact(ContactInfo(CONTACT_TYPE.BUSINESS, CONTACT_MEDIUM.PHONE, "123456789"))
    p1.add_contact(ContactInfo(CONTACT_TYPE.BUSINESS, CONTACT_MEDIUM.EMAIL, "jsmith@email.com"))
    
    passengers_chosen = [p1]
    
    # Chose the legs for the journey from the fare_result object
    legs = [fares_result.results.legs.leg[0].legSolutions.legSolution[0]]
    
    # Select fares chosen from the fare_result object
    fares = [fares_result.results.fareInformation.prices.pointToPointPrice[0]]
    
    # Select passengers for the booking
    passengers = [p1]
    
    # Run booking request
    booking_result = sc.create_booking_from_response(legs, fares, passengers)
    
    print booking_result.requestStatus.success # True

Add payment

Once you have created a booking you can add payments to process the transaction.

    # Specify Billing Address
    b = BillingAddress(
            address1="9 Broad Court, Long Acre",
            city="London",
            zip_code="WC2B 5QN",
            country="GB",
            type=ADDRESS_TYPE.BUSINESS)
    
    # Specify Payment Method
    p = PaymentMethod(
        record_locator=record_locator,
        payment_form="CA",
        payment_form_type=PAYMENT_TYPE.CREDIT_CARD,
        card_number="5425232820001308",
        card_type="CA",
        card_holder_first_name="Jane",
        card_holder_last_name="Smith",
        expiration_year=2016,
        expiration_month=12,
        card_validation_number="123",
        amount=198.20,
        currency="GBP",
        customer_ip_address="1.1.1.1",
        billing_address=b)
    
    payment_response = sc.add_payment(p)
    
    print payment_response.requestStatus.success # True

Update existing bookings

You can update your booking, add/remove ticket options, amend, etc.

    # Create ticket delivery option
    to1 = TicketOption(
        TICKET_DELIVERY_OPTION.VENDING_MACHINE,
        "GBP",
        0.00)
    
    # Add it to a BookingUpdate object
    bu = BookingUpdate(
                    record_locator=record_locator,
                    ticket_option=to1)
    
    booking_update = sc.update_booking(bu)
    
    print booking_update.requestStatus.success # True

Finally - Confirm booking!

Once you are happy with your booking, you can confirm your option.

# Create booking confirmation object
b = BookingConfirmation(
    record_locator=record_locator,
    confirmation_type=CONFIRMATION_TYPE.CREDIT_CARD,
    card_number="5425232820001308",
    expiration_year=2016,
    expiration_month=12,
    card_holder_first_name="Jonathan",
    card_holder_last_name="Harrah")

booking_confirm = sc.confirm_booking(b)

print booking_confirm.requestStatus.success # True

More Advanced commands

Interact with response objects

All response objects belong to the SilverRaw module. This was a module created with the pyxb which creates a python binding with the SilverCore XSD objects. This allows you to interact with raw SilverCore-valid XML. An example of how you can print elements from a FareQuery response is:

    p1 = Passenger(age=30)
    
    tp1 = TravelPoint(
        origin="GBQQU", 
        destination="GBQQM",
        departure=datetime(2015, 11, 16, 12))
    
    fq = FareSearch(
            travel_points = [tp1],
            fare_filter = FARE_FILTER.CHEAPEST,
            passengers = [p1])
    
    fares_result = sc.search_fare(fq)
    
    # You can also interact with the SilverRaw object returned!
    # For a more in-depth example, check out the bottom of this document
    for l in fares_result.results.legs.leg:
        print l.originTravelPoint.value()
        print l.originTravelPoint.type
        print l.destinationTravelPoint.value()
        print l.destinationTravelPoint.type
        
        for s in l.legSolutions.legSolution:
            print s.legSolutionID
            print s.overtakenJourney
            print s.duration
    
    # You can also see the raw XML
    print fares_result.toxml()

Creating objects from XML

You can also create objects from XML using the silverraw.silvercore.CreateFromDocument function!

    xml = """
        <book:updateBookingRecordRequest 
            xmlns:book="http://railgds.net/ws/booking" 
            xmlns:com="http://railgds.net/ws/commontypes">
             <com:context>
                    <com:distributorCode>HACKTRAIN</com:distributorCode>
                    <com:pointOfSaleCode>GB</com:pointOfSaleCode>
                    <com:channelCode>CH1</com:channelCode>
             </com:context>
             <book:recordLocator>B-HACKTRAIN-GVZ000265</book:recordLocator>
             <book:fulfillmentInformation>
                <book:ticketOption code="TVM">
                   <com:fee currency="GBP">0.00</com:fee>
                </book:ticketOption>
             </book:fulfillmentInformation>
          </book:updateBookingRecordRequest>
          """
    
    u = silvercore.CreateFromDocument(xml)
    
    print u # <silverraw.silverbook.UpdateBookingRecordRequestType object at 0x110600450>
    
    # Now we can interact with its inner elements!
    print u.fulfillmentInformation.ticketOption.code # TMV
    print u.fulfillmentInformation.ticketOption.currency # GBP
    print u.fulfillmentInformation.ticketOption.fee.value() # 0,00

Create Booking with Python Objects

In the case where you are not able to do another full query to the SilverCore backend, but you have all the details of the journeys, you can still create a booking using the python Silver.py interface.

    # Create a passenger
    p1 = Passenger(
        id="PAX_SPEC_0",
        age=40,
        first_name="Jane",
        last_name="Smith")
    
    p1.add_contact(ContactInfo(CONTACT_TYPE.UNKNOWN, CONTACT_MEDIUM.PHONE, "123456789"))
    p1.add_contact(ContactInfo(CONTACT_TYPE.BUSINESS, CONTACT_MEDIUM.PHONE, "123456789"))
    p1.add_contact(ContactInfo(CONTACT_TYPE.BUSINESS, CONTACT_MEDIUM.EMAIL, "jsmith@email.com"))
    
    # Specify travel segments
    ts1 = TravelSegment(
            id = "LS_1_1_TS_0", 
            sequence = 0,
            origin = "GBRDG",
            destination = "GBQQM",
            departure = "2015-12-07T06:15:00",
            arrival = "2015-12-07T09:38:00",
            designator = "XC3040",
            marketing_carrier = "CrossCountry",
            operating_carrier = "CrossCountry",
            equipment_type = "ICY",
            equipment_type_str = "Inter-City")
    
    # Add them to their respective legs
    leg1 = Leg(
        id="LS_1_1",
        travel_segments=[ts1])
    
    # Add the respective travel codes
    fc1 = FareCode(
        code="IXC-FOS-00700-STD-1",
        service_class="FIRST",
        travel_segment_id = "LS_1_1_TS_0",
        cabin_class="First",
        fare_display_name="Anytime Single (1st Class)")
    
    # Creating passenger reference
    pr1 = PassengerReference(p1, PASSENGER_TYPE.A, [fc1])
    
    # Specify the fare price breakdown for the total ticketable fare cost 
    price1 = FarePrice(319.52, "TICKET", "USD")
    
    # Specify all ticketable fares
    tf1 = TicketableFare(
            price= 319.52,
            prices = [price1],
            currency="GBP",
            passenger_references=[pr1])
    
    # Add the fare total
    f1 = FareTotal(
            id = "PRICE_P_1_23", 
            currency = "GBP", 
            price = 319.52, 
            expiration = "2015-10-27T15:50:33Z",
            ticketable_fares = [tf1],
            legs = [leg1])
    
    # Run booking request
    booking_result = sc.create_booking([f1], [p1])
    
    print booking_result.requestStatus.success # True

Roadmap

  • We need tests
  • Add support for request parameters
  • Add support for response specifications
  • Add support for all other API message flows not created
    • Validate Booking Information
    • Authenticate Payer
    • Claim Value Document
    • Redeliver Value Document
    • Retreive Cancellation Summary
    • Cancel Booking
    • Refund Booking
    • Generate Payment Token