Services:         VOIP Reseller program   |   Pass-Through Radius   |   Dialup Access   |   Wholesale DSL   
Home
VOIP Reseller Program
- White Label VOIP - soon!
Dial-up Access
- Service Overview
- Dial-up Numbers
- Pricing Options
- Items for Resale
- Selling your ISP?
Wholesale DSL
- Wholesale T1's
- DSL FAQ
DialupUSA Info
- Contact Info
- Company News
- Testimonials
- General Policies
- F.A.Q.
Dialup Backoffice
DSL Backoffice

  Application Program Interface (API)    
 

Last Revised on April 28, 2005.

Revision Notes: GET strings are no longer supported. The API will no longer work when it comes from a webpage containing a refering URL. It requires a script, and cannot be called using form tags inside a webpage, as the user / pass can be seen in the source code of the webpage. Added more optional fields to view_customer_data to support optional fields o3 - o5. Added user_pass_check option. Added mail forwarding option.

Setup Information

Processing URL: https://api.safepages.com/manage.pl (requires SSL).
Supports POST only, GET is not supported for security reasons.

Required Fields

Field NameDescriptionLimitations
login_ridYour back office login3 lowercase letters only
login_pwdSpecial password setup by us for api useup to 35 characters
actionWhat action do you want to performmust exactly equal an action listed below
modeturn on / off test modefor test mode value must equal test

Possible Actions

* All fields are required unless otherwise stated.

Action Fields * Limitations
dialup_add username (see below)
  password (see below)
  acct_num must be all numeric
  already_used Y, or N (default)
(set to Y if trying to add a 2nd user to a same acct num)
 
dialup_edit_pass username (see below)
  password (see below)
 
dialup_edit_status username (see below)
  status enabled, disabled
(both are billable, to avoid biling cancel the account)
 
dialup_cancel username (see below)
 
dialup_schedule_cancel username (see below)
  date YYYY-MM-DD (future date).
To remove schedule date, set to 0000-00-00
 
webaccel_only_add username (see below)
  password (see below)
  acct_num must be all numeric
 
webaccel_add username dialup username to add it to
 
webaccel_cancel username dialup username to cancel it on
 
webaccel_schedule_cancel username dialup username to cancel it on
  date YYYY-MM-DD (future date).
To remove schedule date, set to 0000-00-00
 
email_add username (see below)
  password (see below)
  type must equal dialup, acct_num or standalone
  value this would be either the dialup username or acct_num that this account should be linked to. Must equal the type that you submit. If type is standalone, leave blank.
 
email_edit_pass username (see below)
  password (see below)
 
email_edit_status username (see below) *Command does not integrate with Google Apps Email*
  status enabled, disabled
(both are billable, to avoid biling cancel the account)
 
email_edit_spam username (see below) *Command does not integrate with Google Apps Email*
  spam_filter Y, or N
(turns on / off spam filtering)
  spam_remove Y, or N
(Y deletes all spam, N just tags it as **** SPAM ****)
 
email_edit_forward username (see below) *Command does not integrate with Google Apps Email*
  forward email address to forward to or leave blank to remove forward
 
email_cancel username (see below)
 
email_schedule_cancel username (see below)
  date YYYY-MM-DD (future date).
To remove schedule date, set to 0000-00-00
 
ftp_add username (see below)
  password (see below)
  type must equal dialup, acct_num or standalone
  value this would be either the dialup username or acct_num that this account should be linked to. Must equal the type that you submit. If type is standalone, leave blank.
 
ftp_edit_pass username (see below)
  password (see below)
 
ftp_edit_status username (see below)
  status enabled, disabled
(both are billable, to avoid biling cancel the account)
 
ftp_cancel username (see below)
 
ftp_schedule_cancel username (see below)
  date YYYY-MM-DD (future date).
To remove schedule date, set to 0000-00-00
 
full_cancel type must equal dialup or acct_num
  value this would be either the dialup username or acct_num. Must equal the type that you submit. This will cancel the dialup, email and ftp under this acct_num or dialup.
  acctid set to Y if you want to remove the account id (account history & customer data & billing data). Leave blank to keep this information in our system.
 
full_schedule_cancel type must equal dialup or acct_num
  value this would be either the dialup username or acct_num. Must equal the type that you submit. This will cancel the dialup, email and ftp under this acct_num or dialup.
  date YYYY-MM-DD (future date).
To remove schedule date, set to 0000-00-00
 
user_pass_check username (see below)
  password (see below)
  type must equal dialup or email
 
view_customer_data type must equal dialup, or acct_num
  value this would be either the dialup username or acct_num that should be updated. Must equal the type that you submit. Must be filled in.
  none Gets the customer data and sends it back, Format: "Acct","First Name","Last Name","Address1","Address2", "City","State","Zip","Country","Email","Phone","OS", "O1","O2","O3","O4","O5","Notes"
 
modify_customer_data type must equal dialup, or acct_num
  value this would be either the dialup username or acct_num that should be updated. Must equal the type that you submit. Must be filled in.
  acct optional - new account number
  first_name optional
  last_name optional
  address1 optional
  address2 optional
  city optional
  state optional
  zip optional
  country optional
  email optional
  phone optional
  os optional - operating system
  o1 optional - extra field
  o2 optional - extra field
  o3 optional - extra field
  o4 optional - extra field
  o5 optional - extra field
  notes optional
 
dialup_full_report none grabs a complete list of all dialup data (audit)
Format =
"username","password","acct_num","status","cancel_date", "webaccel","webaccel_cancel_date"
 
email_full_report none grabs a complete list of all email data (audit)
Format =
"username","password","acct_num","status","cancel_date"
 
ftp_full_report none grabs a complete list of all ftp / webspace data (audit)
Format =
"username","password","acct_num","status","cancel_date"
 
usage_report_current none Note: available only for hourly or port customers.
grabs a list of each users time online (current month)
Format =
"username","realm","accesslist","time online (seconds)"
 
usage_report_last none Note: available only for hourly or port customers.
grabs a list of each users time online (previous month)
Format =
"username","realm","accesslist","time online (seconds)"
 
radius_check username The results will show any dial-up attempts for the last 48 hours. Limit of 200 lines in the result. Format =
radius attempt description\n
 
phone_book realm The results will show all dial-up numbers available for the realm Format =
"state","city","number","network","v92",
"isdn64k","isdn128k","multilink","moh"\n
 
network_alerts number Leave number blank to get a list of all alerts in the last 30 days. Format =
"Alert Number","Time in GMT","Subject"\n

To see the ticket, submit the number field equal to the alert number and the alert will be displayed in HTML format.

 
online_invoice start_date must be in format of YYYY-MM-DD
default is first day of current month.
  end_date must be in format of YYYY-MM-DD
default is last day of current month.
    The results will show your online invoice. Format =
"date","type","description","amount"\n

Server Responses

For easy intergration, the server response will always be in the same format. The only exception being the success of a full_report, which will be the complete user information in the format described above.

  1. If it is a success you will receive a Success!.
  2. If it is a failure, you will receive a Failed: error message.

Dont Forget (recommendation)

Prior to doing a dialup_add, email_add, ftp_add, or web_accel add we recommend having your script send a submission in test mode to make sure there is no errors or outages, etc. This will prevent users from being accidently billed and then never setup.

  1. Collect all user information.
  2. Do a mode = test for dialup_add, email_add, ftp_add, webaccel_add.
  3. Bill your user.
  4. Then do a dialup_add, email_add, ftp_add, webaccel_add.

If you use our tech support we require that we have the most up to date first_name, last_name, phone, and email for all customers. This is needed so tech support can easily verify customers, return calls, etc. Also, os (operating system) is recommended. The notes field can be used to pass messages to the tech support reps like "billing declined, have them call XXX-XXX-XXXX".

Username & Password Limitations.

  1. username - format = user@realm or user@domain
  2. username - must begin with a letter or number
  3. username - allowed characters include: @.-_ and lowercase letters, & numbers
  4. username - part before @ cannot be longer than 30 characters.
  5. username - part before @ must be longer than 2 characters.
  6. username - staticusa accounts will not work with the api.
  7. username - cannot contain a space.
  8. password - cannot be longer than 15 characters.
  9. password - must be longer than 2 characters.
  10. password - cannot contain a space.
  11. password - cannot be the same as the username (part before the @ sign)
  12. password - we reject very weak, common passwords.

Special Notes

When using the webaccel_only_add to setup a web accel only account, if you wish to change the features of this account, you will need to use the dial-up options of dialup_edit_pass, dialup_edit_status, dialup_cancel, dialup_schedule_cancel. This type of account cannot be used for dial-up.

Comments or Questions

If you have any comments, or questions or would like to see a feature added, email sales@dialupusa.net . We can't promise that it will be immediatly done, but we are always looking to improve service and satisfy the needs of our customers.