AuthPro API Reference

You can use this API to develop custom scripts to work with Authpro members data.

To connect with API you need to send GET or POST request with appropriate variables to following URL: https://www.authpro.com/cgi-bin/auth.fcgi

You can find list of possible requests below. Please contact us to obtain API key for your account.


Verify member's login and password

VARIABLES:

  • mode = API
  • action = login
  • user = Your authpro account username
  • login = member's login name
  • password = member's password

Response will be either OK or FAIL

If you want to send actual member's IP address to be logged in your AuthPro account please include following variables:

  • IP = member's IP address
  • api_key = your account api key

Add new member

VARIABLES:

  • mode = API
  • action = reg2
  • user = Your authpro account username
  • api_key = account api code

  • _login = new member login name
  • _email = new member email address
  • _password = new member password (optional, will be generated if empty)
  • set_urlok = custom successful login URL (optional)
  • set_urlwrong = custom failed login URL (optional)
  • set_isexphits = set logins expirtion (optional, 0 = no expiration, 1 = suspend, 2 = delete after set_exphits logins)
  • set_exphits = number of logins allowed
  • set_isexptime = set time expirtion (optional, 0 = no expiration, 1 = suspend, 2 = delete after specified period)
  • set_exptime = number of expiration periods
  • set_exptimet = expiration period (m = minutes, h = hours, D = days, M = months, Y = years)
  • IP = member's IP address

any other variables sent will be saved in members profile

Response will be either

  • OK login password
    • or
  • ERROR error message

Update members details

VARIABLES:

  • mode = API
  • action = update
  • user = Your authpro account username
  • api_key = account api code

  • find_member_login = members login name (locate member by login)
    • or
  • find_member_email = members email address (locate member by email)
    • or
  • find_member_ptrans = members paid subscription id (only for paid registrations)

You can only send variables you want to update:

  • login
  • password
  • email
  • urlok
  • urlfail
  • status = A or S or D (active or suspend or delete)
  • is_exp_time = N or S or D (none or suspend or delete)
  • exp_time = number (used with exp_time_type)
  • exp_time_type = m or h or D or M or Y (for minites, hours, days, months or years)
  • is_exp_logins = N or S or D (none or suspend or delete)
  • exp_logins = number of logins

Response will be either OK or ERROR: error message

Get members list

VARIABLES:

  • mode = API
  • action = list
  • user = Your authpro account username
  • api_key = account api code
  • record = pattern to display memebrs record data (example: "{login} {password} {email}")

You can filter records (search) members with specific attributes:

  • login = full or part of members login
  • email = full or part of members email address
  • status = A or S or D (active or suspended or deleted members status)
  • profile = search for specific text in entire members profile
  • profile:field = search for specific text in specified profile field
  • register_after = YYYY-MM-DD (only list member registered after specified data)
  • register_before = YYYY-MM-DD (only list member registered before specified data)

Response will be list of members formatted as specified in record variable