Chilkat Online Tools

Ruby / Salesforce Platform APIs / Registration - Initialize

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "userdata": {
#     "firstName": "userFirstName",
#     "lastName": "userLastName",
#     "email": "<email>",
#     "username": "<username>"
#   },
#   "customdata": {
#     "mobilePhone": "+12035408967",
#     "streetAddress": "12 N Lands End Rd",
#     "city": "Lantana",
#     "state": "Florida",
#     "zip": "20537",
#     "privacyPolicy": true
#   },
#   "password": "Test123!",
#   "recaptcha": "<recaptcha-token>",
#   "verificationmethod": "email"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("userdata.firstName","userFirstName")
json.UpdateString("userdata.lastName","userLastName")
json.UpdateString("userdata.email","<email>")
json.UpdateString("userdata.username","<username>")
json.UpdateString("customdata.mobilePhone","+12035408967")
json.UpdateString("customdata.streetAddress","12 N Lands End Rd")
json.UpdateString("customdata.city","Lantana")
json.UpdateString("customdata.state","Florida")
json.UpdateString("customdata.zip","20537")
json.UpdateBool("customdata.privacyPolicy",true)
json.UpdateString("password","Test123!")
json.UpdateString("recaptcha","<recaptcha-token>")
json.UpdateString("verificationmethod","email")

# resp is a CkHttpResponse
resp = http.PostJson3("https://login.salesforce.com{{site}}/services/auth/headless/init/registration","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-d '{
    "userdata": {
        "firstName": "userFirstName",
        "lastName": "userLastName",
        "email": "<email>",
        "username": "<username>"
    },
    "customdata": {
        "mobilePhone": "+12035408967",
        "streetAddress": "12 N Lands End Rd",
        "city": "Lantana",
        "state": "Florida",
        "zip": "20537",
        "privacyPolicy": true
    },
    "password": "Test123!",
    "recaptcha": "<recaptcha-token>",
    "verificationmethod": "email"
}'
https://login.salesforce.com{{site}}/services/auth/headless/init/registration

Postman Collection Item JSON

{
  "name": "Registration - Initialize",
  "protocolProfileBehavior": {
    "disabledSystemHeaders": {
      "content-type": true
    }
  },
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"userdata\": {\n        \"firstName\": \"userFirstName\",\n        \"lastName\": \"userLastName\",\n        \"email\": \"<email>\",\n        \"username\": \"<username>\"\n    },\n    \"customdata\": {\n        \"mobilePhone\": \"+12035408967\",\n        \"streetAddress\": \"12 N Lands End Rd\",\n        \"city\": \"Lantana\",\n        \"state\": \"Florida\",\n        \"zip\": \"20537\",\n        \"privacyPolicy\": true\n    },\n    \"password\": \"Test123!\",\n    \"recaptcha\": \"<recaptcha-token>\",\n    \"verificationmethod\": \"email\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{url}}{{site}}/services/auth/headless/init/registration",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "auth",
        "headless",
        "init",
        "registration"
      ]
    },
    "description": "Submits the registration data to the init/registration endpoint and returns a request identifier. At the same time, an OTP is sent out to the end users via email or sms. Registration data is passed in the request body, and is formatted with JSON, with 5 keys: `userdata`, `customdata`, `password`, `recaptcha`, and `verificationmethod`. The first two keys are JSON structures, and the last 3 keys are strings.\n\nThis request returns JSON, and includes an identifier (request identifier)."
  },
  "response": [
  ]
}