Signup Service
ShotCode.com Remote Signup Service allows thirdparty resellers to automatically create new ShotCode accounts for their own customers. The signup process can be done with one single call to ShotCode.com service. This is a signed service - that means it requires a valid Reseller Account and an API key in order to work.
Service Endpoint
https://www.shotcode.com/services/v1/signup
Expected Parameters
All parameters required, unless specifically mentioned. Some of them explained [in brackets]):
- User Data:
- - username
- - account_type [accepts only 'basic', 'professional' or 'premium']
- - first_name
- - last_name
- - password [unencrypted plain-text password]
- - street
- - city
- - zip
- - country_code [ISO 3166-1 Alpha-3 code (see http://www.statoids.com/wab.html for a full list)]
Payment Information:- - cardholder_name
- - card_number [credit card number - only numbers, no spaces]
- - cvv [3 digit verification code]
- - card_type [accepts only 'visa' or 'master']
- - expiration_month [month number - from 1 to 12]
- - expiration_year [4-digit credit-card expiration year]
Other parameters:- - api_key [your account api key]
Response Format
<signup>
<username>[username that was just registered]</username>
<status>['ok' or 'failed']</status>
<timestamp>[execution timestamp]</timestamp>
<errors>
<error code="[error code]">[some error message here]</error>
</errors>
</signup>
Please note that there can be one or more <error> entries, one per error message. Also, the <errors> node only exists when status is 'failed'.
Expected Error Codes
e001, e002, e003, e004, e005, e006, e007, e008, e009, e010, e011, e012, e013, e014, e015, e016, e017, e018, e019, e020, e021, e022, e023, e024. The full list of error codes can be seen on the error codes section.
Alternative Method: Integration using html forms
Although not recomended, It is also possible to call the integration API using plain html forms, with little or no programming knowledge. The sample form below contains all the required information for one of such forms:
<form action="https://www.shotcode.com/services/v1/signup" method="post"><h2>User Info</h2>
Username: <input type="text" name="username"/><br/>
Account Type: <select id="register_customer_type" name="account_type">
<option value="basic" selected="selected">Basic (10 ShotCodes)</option>
<option value="professional">Professional (100 ShotCodes)</option>
<option value="premium">Premium (500 ShotCodes)</option>
</select><br/>
First Name: <input type="text" name="first_name"/> <br/>
Last Name: <input type="text" name="last_name"/> <br/>
Password: <input type="text" name="password"/> <br/>
E-mail: <input type="text" name="email"/> <br/>
Street: <input type="text" name="street"/> <br/>
City: <input type="text" name="city"/> <br/>
Zip Code: <input type="text" name="zip"/> <br/>
Country Code: <input type="text" name="country_code"/> <br/>
<h2>Credit Card Info</h2>
Card Holder Name: <input type="text" name="cardholder_name"/> <br/>
Credit Card Number: <input type="text" name="card_number"/> <br/>
CVV: <input type="text" name="cvv"/> <br/>
Credit Card Type:
Expiration Month: <select name="expiration_month">
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
<option value="4">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
<option value="8">8</option>
<option value="9">9</option>
<option value="10">10</option>
<option value="11">11</option>
<option value="12">12</option>
</select> <br/>
Expiration Year: <select name="expiration_year">
<option value="2007">2007</option>
<option value="2008">2008</option>
<option value="2009">2009</option>
<option value="2010">2010</option>
<option value="2011">2011</option>
<option value="2012">2012</option>
<option value="2013">2013</option>
<option value="2014">2014</option>
<option value="2015">2015</option>
<option value="2016">2016</option>
<option value="2017">2017</option>
</select><br/>
<input type="hidden" name="reseller" value="<your reseller login name>"/>
<input type="hidden" name="mode" value="html"/>
<input type="hidden" name="on_success" value="http://<your success page>.html"/>
<input type="hidden" name="on_error" value="http://<your error page>.html"/>
<input type="submit"/>
</form>
The only change that has to be made is the "reseller" hidden attribute and the two callbacks (on_error and on_success): just change the
value of "<your reseller login name>" to your reseller username (same one used to sign in) and the "on_error" and "on_success" to point to your
own site's success and error pages.
The "on_error" endpoint can also process which were the exact errors that happened: when ShotCode.com website detects errors and redirects to that page,
it includes the errors as request parameters (both descriptions and error codes). Supposing you set on_error to "http://www.mysite.com/error.php" and there were 3 processing errors,
here's what the site redirect will look like: http://www.mysite.com/error.php?error=Something+wrong&error=Something+else&error=ooops&error_code=13&error_code=44&error_code=21
Notice that the country code is typed in, on that example: see the Appendix I below for a better way of picking it.
Appendix I: country codes
The following piece of HTML contains the valid country codes as a select field where users can pick a country:
<select name="country_code"><option value="" selected="selected">Choose a country</option><option value="AFG">Afghanistan</option><option value="ALB">Albania</option><option value="DZA">Algeria</option><option value="ASM">American Samoa</option><option value="AND">Andorra</option><option value="AGO">Angola</option><option value="AIA">Anguilla</option><option value="ATA">Antarctica</option><option value="ATG">Antigua and Barbuda</option><option value="ARG">Argentina</option><option value="ARM">Armenia</option><option value="ABW">Aruba</option><option value="AUS">Australia</option><option value="AUT">Austria</option><option value="AZE">Azerbaijan</option><option value="BHS">Bahamas</option><option value="BHR">Bahrain</option><option value="BGD">Bangladesh</option><option value="BRB">Barbados</option><option value="BLR">Belarus</option><option value="BEL">Belgium</option><option value="BLZ">Belize</option><option value="BEN">Benin</option><option value="BMU">Bermuda</option><option value="BTN">Bhutan</option><option value="BOL">Bolivia</option><option value="BIH">Bosnia and Herzegovina</option><option value="BWA">Botswana</option><option value="BVT">Bouvet Island</option><option value="BRA">Brazil</option><option value="IOT">British Indian Ocean Territory</option><option value="BRN">Brunei</option><option value="BGR">Bulgaria</option><option value="BFA">Burkina Faso</option><option value="BDI">Burundi</option><option value="KHM">Cambodia</option><option value="CMR">Cameroon</option><option value="CAN">Canada</option><option value="CPV">Cape Verde</option><option value="CYM">Cayman Islands</option><option value="CAF">Central African Republic</option><option value="TCD">Chad</option><option value="CHL">Chile</option><option value="CHN">China</option><option value="CXR">Christmas Island</option><option value="CCK">Cocos (Keeling) Islands</option><option value="COL">Colombia</option><option value="COM">Comoros</option><option value="COG">Congo</option><option value="COD">Congo, The Democratic Republic of the</option><option value="COK">Cook Islands</option><option value="CRI">Costa Rica</option><option value="CIV">Cote d'Ivoire</option><option value="HRV">Croatia</option><option value="CUB">Cuba</option><option value="CYP">Cyprus</option><option value="CZE">Czech Republic</option><option value="DNK">Denmark</option><option value="DJI">Djibouti</option><option value="DMA">Dominica</option><option value="DOM">Dominican Republic</option><option value="TMP">East Timor</option><option value="ECU">Ecuador</option><option value="EGY">Egypt</option><option value="SLV">El Salvador</option><option value="GNQ">Equatorial Guinea</option><option value="ERI">Eritrea</option><option value="EST">Estonia</option><option value="ETH">Ethiopia</option><option value="FLK">Falkland Islands</option><option value="FRO">Faroe Islands</option><option value="FJI">Fiji Islands</option><option value="FIN">Finland</option><option value="FRA">France</option><option value="GUF">French Guiana</option><option value="PYF">French Polynesia</option><option value="ATF">French Southern territories</option><option value="GAB">Gabon</option><option value="GMB">Gambia</option><option value="GEO">Georgia</option><option value="DEU">Germany</option><option value="GHA">Ghana</option><option value="GIB">Gibraltar</option><option value="GRC">Greece</option><option value="GRL">Greenland</option><option value="GRD">Grenada</option><option value="GLP">Guadeloupe</option><option value="GUM">Guam</option><option value="GTM">Guatemala</option><option value="GIN">Guinea</option><option value="GNB">Guinea-Bissau</option><option value="GUY">Guyana</option><option value="HTI">Haiti</option><option value="HMD">Heard Island and McDonald Islands</option><option value="VAT">Holy See (Vatican City State)</option><option value="HND">Honduras</option><option value="HKG">Hong Kong</option><option value="HUN">Hungary</option><option value="ISL">Iceland</option><option value="IND">India</option><option value="IDN">Indonesia</option><option value="IRN">Iran</option><option value="IRQ">Iraq</option><option value="IRL">Ireland</option><option value="ISR">Israel</option><option value="ITA">Italy</option><option value="JAM">Jamaica</option><option value="JPN">Japan</option><option value="JOR">Jordan</option><option value="KAZ">Kazakstan</option><option value="KEN">Kenya</option><option value="KIR">Kiribati</option><option value="KWT">Kuwait</option><option value="KGZ">Kyrgyzstan</option><option value="LAO">Laos</option><option value="LVA">Latvia</option><option value="LBN">Lebanon</option><option value="LSO">Lesotho</option><option value="LBR">Liberia</option><option value="LBY">Libyan Arab Jamahiriya</option><option value="LIE">Liechtenstein</option><option value="LTU">Lithuania</option><option value="LUX">Luxembourg</option><option value="MAC">Macao</option><option value="MKD">Macedonia</option><option value="MDG">Madagascar</option><option value="MWI">Malawi</option><option value="MYS">Malaysia</option><option value="MDV">Maldives</option><option value="MLI">Mali</option><option value="MLT">Malta</option><option value="MHL">Marshall Islands</option><option value="MTQ">Martinique</option><option value="MRT">Mauritania</option><option value="MUS">Mauritius</option><option value="MYT">Mayotte</option><option value="MEX">Mexico</option><option value="FSM">Micronesia, Federated States of</option><option value="MDA">Moldova</option><option value="MCO">Monaco</option><option value="MNG">Mongolia</option><option value="MSR">Montserrat</option><option value="MAR">Morocco</option><option value="MOZ">Mozambique</option><option value="MMR">Myanmar</option><option value="NAM">Namibia</option><option value="NRU">Nauru</option><option value="NPL">Nepal</option><option value="NLD">Netherlands</option><option value="ANT">Netherlands Antilles</option><option value="NCL">New Caledonia</option><option value="NZL">New Zealand</option><option value="NIC">Nicaragua</option><option value="NER">Niger</option><option value="NGA">Nigeria</option><option value="NIU">Niue</option><option value="NFK">Norfolk Island</option><option value="PRK">North Korea</option><option value="MNP">Northern Mariana Islands</option><option value="NOR">Norway</option><option value="OMN">Oman</option><option value="PAK">Pakistan</option><option value="PLW">Palau</option><option value="PSE">Palestine</option><option value="PAN">Panama</option><option value="PNG">Papua New Guinea</option><option value="PRY">Paraguay</option><option value="PER">Peru</option><option value="PHL">Philippines</option><option value="PCN">Pitcairn</option><option value="POL">Poland</option><option value="PRT">Portugal</option><option value="PRI">Puerto Rico</option><option value="QAT">Qatar</option><option value="REU">R?union</option><option value="ROM">Romania</option><option value="RUS">Russian Federation</option><option value="RWA">Rwanda</option><option value="SHN">Saint Helena</option><option value="KNA">Saint Kitts and Nevis</option><option value="LCA">Saint Lucia</option><option value="SPM">Saint Pierre and Miquelon</option><option value="VCT">Saint Vincent and the Grenadines</option><option value="WSM">Samoa</option><option value="SMR">San Marino</option><option value="STP">Sao Tome and Principe</option><option value="SAU">Saudi Arabia</option><option value="SEN">Senegal</option><option value="SYC">Seychelles</option><option value="SLE">Sierra Leone</option><option value="SGP">Singapore</option><option value="SVK">Slovakia</option><option value="SVN">Slovenia</option><option value="SLB">Solomon Islands</option><option value="SOM">Somalia</option><option value="ZAF">South Africa</option><option value="SGS">South Georgia and the South Sandwich Islands</option><option value="KOR">South Korea</option><option value="ESP">Spain</option><option value="LKA">Sri Lanka</option><option value="SDN">Sudan</option><option value="SUR">Suriname</option><option value="SJM">Svalbard and Jan Mayen</option><option value="SWZ">Swaziland</option><option value="SWE">Sweden</option><option value="CHE">Switzerland</option><option value="SYR">Syria</option><option value="TWN">Taiwan</option><option value="TJK">Tajikistan</option><option value="TZA">Tanzania</option><option value="THA">Thailand</option><option value="TGO">Togo</option><option value="TKL">Tokelau</option><option value="TON">Tonga</option><option value="TTO">Trinidad and Tobago</option><option value="TUN">Tunisia</option><option value="TUR">Turkey</option><option value="TKM">Turkmenistan</option><option value="TCA">Turks and Caicos Islands</option><option value="TUV">Tuvalu</option><option value="UGA">Uganda</option><option value="UKR">Ukraine</option><option value="ARE">United Arab Emirates</option><option value="GBR">United Kingdom</option><option value="USA">United States</option><option value="UMI">United States Minor Outlying Islands</option><option value="URY">Uruguay</option><option value="UZB">Uzbekistan</option><option value="VUT">Vanuatu</option><option value="VEN">Venezuela</option><option value="VNM">Vietnam</option><option value="VGB">Virgin Islands, British</option><option value="VIR">Virgin Islands, U.S.</option><option value="WLF">Wallis and Futuna</option><option value="ESH">Western Sahara</option><option value="YEM">Yemen</option><option value="YUG">Yugoslavia</option><option value="ZMB">Zambia</option><option value="ZWE">Zimbabwe</option>
</select>
