Difference between revisions of "Adding Web Server Access Accounts"

From Rts
Jump to: navigation, search
(Creating a Web Server API Selling Account)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Creating a Web Server Schedule Account==
+
Web Server Access accounts allow third parties to pull your schedule and / or sell  tickets and gift cards.<br>
 +
<br>
 +
There are 4 steps for setting up a Web API account:<br>
 +
<br>
 +
1) Create an Adjust item<br>
 +
2) Generate a password<br>
 +
3) Create Web Server Access Accounts (2)<br>
 +
* A Schedule account is needed to allow the user to access showtimes.
 +
* A Selling account is needed to allow the user to sell tickets or gift cards.
 +
4) Enable Specific Ticket Access<br>
 +
<br>
  
Adding an account here will allow the user to access your RTS schedule.
+
==Creating a Transaction Adjust Item==
 +
If you are adding an account for a third party website to sell tickets, RTS will need an item created to account for the price of tickets sold. If RTS does not charge the customer, the adjust item is used to balance the register when sales are passed into RTS.<br>
 +
To create this item:
 +
*Navigate to <code>Setup -> Concessions -> Items</code>
 +
*Click "Add"
 +
*Click "Yes" to the warning
 +
*Enter the item name. For this, we suggest "[Name of Company] Adjust".
 +
**<I>Example - if you are granting the BoxOffice Company access, the item name would be "BoxOffice Adjust"</i>
 +
*Leave the price at 0.
 +
**<i>The user will pass in their own price at the time of the transaction according to the transaction total.</i>
 +
*Click the Subtotal Tab
 +
*Click "Edit Subtotals"
 +
*Click "Add" and name this new subtotal the same as the item name
 +
*Set this subtotal as a deduction and click "Save"
 +
*Assign you adjust item to your new subtotal and press "Save"
 +
*Navigate to <code>Setup -> Concessions -> Station Items</code>
 +
*Set the Current Station dropdown to Station 99
 +
*Find the adjust item created and add it to the "Station Item List". The item will be of type "Selling" and will Stock From "Create"
 +
<br>
 +
==Generating a Password==
 +
The user will need a password in order to access the API. This password can be anything. However, it is recommended to use a GUID as a password. A GUID generator that can create one of these for you can be found here:<br>
 +
<br>
 +
[https://www.guidgenerator.com/online-guid-generator.aspx Online GUID Generator]<br>
 +
<br>
 +
==Creating a Web Server API Schedule Account==
 +
Adding an account here will allow the user to access your RTS schedule.<br>
 +
<br>
 +
*Navigate to <code>'''Setup -> Ready Ticket Network -> Web Server Passwords'''</code>.
 +
*Select the "'''Show Schedule'''" tab.
 +
<br>
 +
[[File:SU_RTN_WebServerPasswords.PNG|300px]]<br/><br/>
 +
*Press "'''Add'''".
 +
*Enter the Account Name, this is typically the name of the company (i.e. "BoxOffice Company).
 +
*Enter the username in the UserName field. This can be the same as the Account Name
 +
*Enter the password generated above in the password field.
 +
*Check to enable '''"Send Admission Counts"'''.
 +
*Check to enable '''"Send Ticket Availability"'''.
 +
*'''"Save"'''.
 +
<br>
 +
==Creating a Web Server API Selling Account==
 +
Adding an account here will allow the user to sell using the RTS API.<br>
 +
<br>
 +
[[File:Rts_setup_rtn_webPass_inet.png|300px]]<br/><br/>
 +
* Go to <code>'''Setup -> Ready Ticket Network -> Web Server Passwords'''</code>.
 +
* Select the "'''Internet Sales'''" tab.
 +
* Press "'''Add'''".
 +
* Enter the Account Name. If you have set up a Schedule Account for this user, you can use the same Account Name here.
 +
* Enter the username in the UserName field. If you have set up a Schedule Account for this user, you can use the same UserName here.
 +
* Enter the password in the Password field. If you have set up a Schedule Account for this user, you can use the same Password here.
 +
* Enter the encryption key into the Encryption Key field. For this, you may also enter the password filled out in the Password field.
 +
* Select a ticket fee item from the available items in the Ticket Fee item selection. Most commonly, this is set to "Internet Fee".
 +
* Select a transaction fee item from the available items in the Transaction Fee item selection. Most commonly, this is also set to "Internet Fee".
 +
* Select an adjustment item from the available items. <u>This will be the adjust item you set up previously.</u>
 +
* Check to enable "'''Sell Internet Tickets'''"
 +
* Check "'''Send Confirmation Email'''" if RTS will be sending confirmation emails otherwise API user will be responsible for sending emails.
 +
* Check to enable "'''Sell Gift Certificates'''" if applicable.
 +
* Check to enable "'''Strict AVS / CVV'''" if applicable.
 +
* Check to enable "'''Disable Custom Seat Types'''" if applicable.
 +
* '''"Save"'''.
 +
<br>
  
# Navigate to <code>Setup - Ready Ticket Network - Web Server Passwords</code>
+
==Enabling Tickets for API Access==
# Select the "'''Show Schedule'''" tab.
+
Now that the API user account has been created, they will need access to certain ticket types. Granting them this on a per-ticket basis will allow you to choose which tickets will display where. For example, if you wish to set up a Fandango specific ticket and not allow Atom to sell it, you can enable API access only for Fandango.<br>
________Need image _____________________
+
<br>
# Press "'''Add'''"
+
*Navigate to Setup -> Tickets -> Price.
# Enter the Account Name
+
*Select the Ticket Price Category you are using and click "Edit". If you have multiple, the below steps must be completed for each ticket within each Price Category you wish to enable.
# Enter the username in the UserName field
+
*Find the ticket(s) you are wanting to enable access for, then check off the "Enabled Web API Access" option.
# Enter the password in the password field
+
*In the top right, you will now have options between all API users currently configured. Check off each user you wish to have access to that ticket type.
# Check to enable '''"Send Admission Counts"''' if applicable.
+
*Repeat the above two steps for each ticket you wish to enable.
# Check to enable '''"Send Ticket Availability"''' if applicable.
+
*Click "Save and Close"
# Save.
+
<br>
 +
[[File:2020-05-20_16-20-18.gif|500px]]<br><br>
  
[[File:Config.WSA1.JPG|300px]]<br/><br/>
 
  
==Creating a Web Server Selling Account==
+
==IMPORTANT INFORMATION==
 
+
*<u>You will need to restart the software on your RTS Server for these changes to take immediate effect. This can be done by going to <code>'''File -> Other -> Restart Software'''</code>, then press "'''Yes'''".</u>
Adding an account here will allow the user to sell using the RTS API.
+
*After configuring a Web API Account, the user will need to following information in order to make use of it:
 
+
**RTN Number
# Go to <code>Setup - Ready Ticket Network - Web Server Passwords</code>
+
***This can be found in the top left corner of RTS inside the "R:{#}"
# Select the "'''Internet Sales'''" tab.
+
**UserName
# Press "'''Add'''"
+
***This will be the one you created
# Enter the Account Name
+
**Password
# Enter the username in the UserName field
+
***This will be the one you created
# Enter the password in the Password field
+
**Web API Documentation
# Enter the encryption key into the Encryption Key field (in most cases, you will submit the password into this field)
+
***This can be found [http://readyticket.net/download/rts_purchase_interface.pdf Here]
# Select a ticket fee item from the available items in the Ticket Fee item selection.
 
# Select a transaction fee item from the available items in the Transaction Fee item selection.
 
# Select an adjustment item from the available items in the Adjust Item - item selection. (This item will be used to offset any payments that would be done outside of the RTS credit card and gift card payment options) See [[General Item Setup and Configuration]] for instructions on adding items.
 
# Check to enable "'''Sell Gift Certificates'''" if applicable.
 
# Check to enable "'''Sell Internet Tickets'''" if applicable.
 
# Check to enable "'''Strict AVS / CVV'''" if applicable.
 
# Check to enable "'''Disable Custom Seat Types'''" if applicable.
 
# Save
 
 
 
 
 
[[File:Config.WSA2.JPG|300px]]<br/><br/>
 
 
 
 
 
'''IMPORTANT INFORMATION'''
 
----
 
You will need to restart the software on your RTS Server for these changes to take immediate effect.  
 
This can be done by going to <code>File - Other - Restart Software</code>, then press "'''Yes'''"
 
 
 
Most Web server users will also need your location ID. Also known as your RTN Number. This can be found by going to <code>Help -> About</code> from within RTS.
 

Latest revision as of 20:37, 10 July 2020

Web Server Access accounts allow third parties to pull your schedule and / or sell tickets and gift cards.

There are 4 steps for setting up a Web API account:

1) Create an Adjust item
2) Generate a password
3) Create Web Server Access Accounts (2)

  • A Schedule account is needed to allow the user to access showtimes.
  • A Selling account is needed to allow the user to sell tickets or gift cards.

4) Enable Specific Ticket Access

Creating a Transaction Adjust Item

If you are adding an account for a third party website to sell tickets, RTS will need an item created to account for the price of tickets sold. If RTS does not charge the customer, the adjust item is used to balance the register when sales are passed into RTS.
To create this item:

  • Navigate to Setup -> Concessions -> Items
  • Click "Add"
  • Click "Yes" to the warning
  • Enter the item name. For this, we suggest "[Name of Company] Adjust".
    • Example - if you are granting the BoxOffice Company access, the item name would be "BoxOffice Adjust"
  • Leave the price at 0.
    • The user will pass in their own price at the time of the transaction according to the transaction total.
  • Click the Subtotal Tab
  • Click "Edit Subtotals"
  • Click "Add" and name this new subtotal the same as the item name
  • Set this subtotal as a deduction and click "Save"
  • Assign you adjust item to your new subtotal and press "Save"
  • Navigate to Setup -> Concessions -> Station Items
  • Set the Current Station dropdown to Station 99
  • Find the adjust item created and add it to the "Station Item List". The item will be of type "Selling" and will Stock From "Create"


Generating a Password

The user will need a password in order to access the API. This password can be anything. However, it is recommended to use a GUID as a password. A GUID generator that can create one of these for you can be found here:

Online GUID Generator

Creating a Web Server API Schedule Account

Adding an account here will allow the user to access your RTS schedule.

  • Navigate to Setup -> Ready Ticket Network -> Web Server Passwords.
  • Select the "Show Schedule" tab.


SU RTN WebServerPasswords.PNG

  • Press "Add".
  • Enter the Account Name, this is typically the name of the company (i.e. "BoxOffice Company).
  • Enter the username in the UserName field. This can be the same as the Account Name
  • Enter the password generated above in the password field.
  • Check to enable "Send Admission Counts".
  • Check to enable "Send Ticket Availability".
  • "Save".


Creating a Web Server API Selling Account

Adding an account here will allow the user to sell using the RTS API.

Rts setup rtn webPass inet.png

  • Go to Setup -> Ready Ticket Network -> Web Server Passwords.
  • Select the "Internet Sales" tab.
  • Press "Add".
  • Enter the Account Name. If you have set up a Schedule Account for this user, you can use the same Account Name here.
  • Enter the username in the UserName field. If you have set up a Schedule Account for this user, you can use the same UserName here.
  • Enter the password in the Password field. If you have set up a Schedule Account for this user, you can use the same Password here.
  • Enter the encryption key into the Encryption Key field. For this, you may also enter the password filled out in the Password field.
  • Select a ticket fee item from the available items in the Ticket Fee item selection. Most commonly, this is set to "Internet Fee".
  • Select a transaction fee item from the available items in the Transaction Fee item selection. Most commonly, this is also set to "Internet Fee".
  • Select an adjustment item from the available items. This will be the adjust item you set up previously.
  • Check to enable "Sell Internet Tickets"
  • Check "Send Confirmation Email" if RTS will be sending confirmation emails otherwise API user will be responsible for sending emails.
  • Check to enable "Sell Gift Certificates" if applicable.
  • Check to enable "Strict AVS / CVV" if applicable.
  • Check to enable "Disable Custom Seat Types" if applicable.
  • "Save".


Enabling Tickets for API Access

Now that the API user account has been created, they will need access to certain ticket types. Granting them this on a per-ticket basis will allow you to choose which tickets will display where. For example, if you wish to set up a Fandango specific ticket and not allow Atom to sell it, you can enable API access only for Fandango.

  • Navigate to Setup -> Tickets -> Price.
  • Select the Ticket Price Category you are using and click "Edit". If you have multiple, the below steps must be completed for each ticket within each Price Category you wish to enable.
  • Find the ticket(s) you are wanting to enable access for, then check off the "Enabled Web API Access" option.
  • In the top right, you will now have options between all API users currently configured. Check off each user you wish to have access to that ticket type.
  • Repeat the above two steps for each ticket you wish to enable.
  • Click "Save and Close"


2020-05-20 16-20-18.gif


IMPORTANT INFORMATION

  • You will need to restart the software on your RTS Server for these changes to take immediate effect. This can be done by going to File -> Other -> Restart Software, then press "Yes".
  • After configuring a Web API Account, the user will need to following information in order to make use of it:
    • RTN Number
      • This can be found in the top left corner of RTS inside the "R:{#}"
    • UserName
      • This will be the one you created
    • Password
      • This will be the one you created
    • Web API Documentation
      • This can be found Here