•  Summary

• 1 • interact with the forum
• • 1.1 • SDK
  • 1.2 • SOAP Webservices
• 2 • Important variables and “simple” functions
• • 2.1 • Important variables provided by initialize.php. Useful when using the SDK.
  • 2.2 • Essential Information
  • • 2.2.1 • For the SDK
    • 2.2.2 • For SOAP and PHP webservices
    • 2.2.3 • Retrieving the different IDs
  • 2.3 • SDK Function Examples
  • • 2.3.1 • Retrieving a topic title
    • 2.3.2 • Retrieve the number of registered members on a given forum or on all the forums hosted by the server.
    • 2.3.3 • Activating email notification
    • 2.3.4 • Create a new topic
    • 2.3.5 • Add a reply to a topic
• 3 • SDK Tutorial
• • 3.1 • Tutorial: Create a personalized homepage
• 4 • Webservices
• • 4.1 • Webservice : create_topic
  • 4.2 • Add Answer Webservice
  • 4.3 • Message Edition Webservice
  • 4.4 • Message/Topic Deletion Webservice
  • 4.5 • Sub category Creation Webservice
  • 4.6 • Sub category URL Retrieval Webservice
  • 4.7 • Sub category renaming Webservice
  • 4.8 • Sub category Deletion Webservice
  • 4.9 • Sub category Topics Display Webservices
  • 4.10 • Topic URL Retrieval WebService
  • 4.11 • Topic Reply Number and URL Retrieval Webservice
  • 4.12 • Topic Content Retrieval Webservice
  • 4.13 • Topic Content Retrieval Webservice: offset
  • • 4.13.1 • Pagination Management Example via the read_topic_page Webservice
  • 4.14 • User Creation Webservice
  • • 4.14.1 • create_user_auto
    • 4.14.2 • create_user_with_id
  • 4.15 • User Password Update Webservice
  • 4.16 • User Email Update Webservice

4.14  User Creation Webservice

There are two ways to create a new user with the webservices. In every case, 4 parameters are required:

• Login ID of the account to create

• Password of the account to create

• Email of the member

• ID of the forum where the member is to be registered

Then you can let the webservice return a unique ID number that you can backup on your side, useful in case of synchronization. You can also create the user first on your side and then create the user on the forum by specifying the ID number.

4.14.1  create_user_auto

With this webservice you can enable automatic user creation. Here are the parameters

• admin : login of the forum administrator

• adminpwd : password of the forum administrator

• user : login or nickname of the user to create

• pwd : password of the user (non encrypted)

• email : Email of the user. Warning: keep in mind that this email address should not already exist for another member of the forum. Otherwise, it will purge the account of the member who firstly registered with this email address.

• idforum : ID of the forum where the user should be registered..

A PHP example

The webservice returns several parameters if everything went right

• iduser : unique ID of the newly created user

• status : Status is a string which can contain "New user" or "Already exist". The first one if the user has already been created, the second one if there was already member with this pseudo and this password

4.14.2  create_user_with_id

This webservice enables you to automatically create users by specifying their unique ID. Here are the parameters

• admin : Login of a forum administrator

• adminpwd : password of a forum administrator

• iduser : unique ID of the user

• user : Login or pseudo of the user to be created

• pwd : user password (non encrypted)

• pwdmd5 : md5 type user password. This enables you to synchronize a data basis if you have not backed up the password.

  When sending the password in the MD5 format, you need to send an empty string for the pwd parameter to include it.

• email : User Email. Warning: keep in mind that this email address should not already exist for another member of the forum. Otherwise, it will purge the account of the member who firstly registered with this email address.

• idforum : ID of the forum where the user will be registered..

A PHP example

If everything went fine, the webservice should return several parameters

• iduser : The unique ID of the newly-created user (which must equal the transmitted ID)

• status : Status is a string which can contain "New user" or "Already exist". The first one if the user has already been created, the second one if there was already member with this pseudo and this password