Chilkat Online Tools

Xojo / Salesforce Platform APIs / SOAP Login

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample XML: Generate Code to Create XML

// The following XML is sent in the request body.

// <?xml version="1.0" encoding="utf-8"?>
// <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
//     <env:Body>
//         <n1:login xmlns:n1="urn:partner.soap.sforce.com">
//             <n1:username><![CDATA[{{username}}]]></n1:username>
//             <n1:password><![CDATA[{{password}}{{secretToken}}]]></n1:password>
//         </n1:login>
//     </env:Body>
// </env:Envelope>
// 

Dim xml As New Chilkat.Xml
xml.Tag = "env:Envelope"
success = xml.AddAttribute("xmlns:xsd","http://www.w3.org/2001/XMLSchema")
success = xml.AddAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance")
success = xml.AddAttribute("xmlns:env","http://schemas.xmlsoap.org/soap/envelope/")
success = xml.UpdateAttrAt("env:Body|n1:login",True,"xmlns:n1","urn:partner.soap.sforce.com")
xml.UpdateChildContent "env:Body|n1:login|n1:username","{{username}}"
xml.UpdateChildContent "env:Body|n1:login|n1:password","{{password}}{{secretToken}}"

http.SetRequestHeader "Content-Type","text/xml; charset=UTF-8"
http.SetRequestHeader "SOAPAction","login"
http.SetRequestHeader "Accept","text/xml"

Dim sbRequestBody As New Chilkat.StringBuilder
success = xml.GetXmlSb(sbRequestBody)

Dim resp As New Chilkat.HttpResponse
success = http.HttpSb("POST","https://login.salesforce.com{{site}}/services/Soap/u/{{version}}",sbRequestBody,"utf-8","text/xml; charset=UTF-8",resp)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim xmlResponse As New Chilkat.Xml
success = xmlResponse.LoadSb(sbResponseBody,True)
System.DebugLog(xmlResponse.GetXml())

// Sample XML response:
// (Sample code for parsing the XML response is shown below)

// <?xml version="1.0" encoding="UTF-8"?>
// <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
//     <soapenv:Body>
//         <loginResponse>
//             <result>
//                 <metadataServerUrl>https://pozil-dev-ed.my.salesforce.com/services/Soap/m/50.0/00D58000000arpq</metadataServerUrl>
//                 <passwordExpired>false</passwordExpired>
//                 <sandbox>false</sandbox>
//                 <serverUrl>https://pozil-dev-ed.my.salesforce.com/services/Soap/u/50.0/00D58000000arpq</serverUrl>
//                 <sessionId>SECRET_SESSION_ID_GOES_HERE</sessionId>
//                 <userId>00558000000yFyDAAU</userId>
//                 <userInfo>
//                     <accessibilityMode>false</accessibilityMode>
//                     <chatterExternal>false</chatterExternal>
//                     <currencySymbol>€</currencySymbol>
//                     <orgAttachmentFileSizeLimit>26214400</orgAttachmentFileSizeLimit>
//                     <orgDefaultCurrencyIsoCode>EUR</orgDefaultCurrencyIsoCode>
//                     <orgDefaultCurrencyLocale>fr_FR_EURO</orgDefaultCurrencyLocale>
//                     <orgDisallowHtmlAttachments>false</orgDisallowHtmlAttachments>
//                     <orgHasPersonAccounts>false</orgHasPersonAccounts>
//                     <organizationId>00D58000000arpqEAA</organizationId>
//                     <organizationMultiCurrency>false</organizationMultiCurrency>
//                     <organizationName>pozil DE</organizationName>
//                     <profileId>00e58000000wYTOAA2</profileId>
//                     <roleId xsi:nil="true"/>
//                     <sessionSecondsValid>7200</sessionSecondsValid>
//                     <userDefaultCurrencyIsoCode xsi:nil="true"/>
//                     <userEmail>demo@pozil.org</userEmail>
//                     <userFullName>Philippe Ozil</userFullName>
//                     <userId>00558000000yFyDAAU</userId>
//                     <userLanguage>en_US</userLanguage>
//                     <userLocale>fr_FR</userLocale>
//                     <userName>demo@pozil.org</userName>
//                     <userTimeZone>Europe/Paris</userTimeZone>
//                     <userType>Standard</userType>
//                     <userUiSkin>Theme3</userUiSkin>
//                 </userInfo>
//             </result>
//         </loginResponse>
//     </soapenv:Body>
// </soapenv:Envelope>

// Sample code for parsing the XML response...
// Use this online tool to generate parsing code from sample XML: Generate XML Parsing Code

Dim soapenv_Envelope_xmlns_soapenv As String
soapenv_Envelope_xmlns_soapenv = xmlResponse.GetAttrValue("xmlns:soapenv")
Dim soapenv_Envelope_xmlns As String
soapenv_Envelope_xmlns = xmlResponse.GetAttrValue("xmlns")
Dim soapenv_Envelope_xmlns_xsi As String
soapenv_Envelope_xmlns_xsi = xmlResponse.GetAttrValue("xmlns:xsi")
Dim metadataServerUrl As String
metadataServerUrl = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|metadataServerUrl")
Dim passwordExpired As String
passwordExpired = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|passwordExpired")
Dim sandbox As String
sandbox = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|sandbox")
Dim serverUrl As String
serverUrl = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|serverUrl")
Dim sessionId As String
sessionId = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|sessionId")
Dim userId As String
userId = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userId")
Dim accessibilityMode As String
accessibilityMode = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|accessibilityMode")
Dim chatterExternal As String
chatterExternal = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|chatterExternal")
Dim currencySymbol As String
currencySymbol = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|currencySymbol")
Dim orgAttachmentFileSizeLimit As Int32
orgAttachmentFileSizeLimit = xmlResponse.GetChildIntValue("soapenv:Body|loginResponse|result|userInfo|orgAttachmentFileSizeLimit")
Dim orgDefaultCurrencyIsoCode As String
orgDefaultCurrencyIsoCode = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDefaultCurrencyIsoCode")
Dim orgDefaultCurrencyLocale As String
orgDefaultCurrencyLocale = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDefaultCurrencyLocale")
Dim orgDisallowHtmlAttachments As String
orgDisallowHtmlAttachments = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDisallowHtmlAttachments")
Dim orgHasPersonAccounts As String
orgHasPersonAccounts = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgHasPersonAccounts")
Dim organizationId As String
organizationId = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationId")
Dim organizationMultiCurrency As String
organizationMultiCurrency = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationMultiCurrency")
Dim organizationName As String
organizationName = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationName")
Dim profileId As String
profileId = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|profileId")
Dim roleId_xsi_nil As String
roleId_xsi_nil = xmlResponse.ChilkatPath("soapenv:Body|loginResponse|result|userInfo|roleId|(xsi:nil)")
Dim sessionSecondsValid As Int32
sessionSecondsValid = xmlResponse.GetChildIntValue("soapenv:Body|loginResponse|result|userInfo|sessionSecondsValid")
Dim userDefaultCurrencyIsoCode_xsi_nil As String
userDefaultCurrencyIsoCode_xsi_nil = xmlResponse.ChilkatPath("soapenv:Body|loginResponse|result|userInfo|userDefaultCurrencyIsoCode|(xsi:nil)")
Dim userEmail As String
userEmail = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userEmail")
Dim userFullName As String
userFullName = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userFullName")
userId = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userId")
Dim userLanguage As String
userLanguage = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userLanguage")
Dim userLocale As String
userLocale = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userLocale")
Dim userName As String
userName = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userName")
Dim userTimeZone As String
userTimeZone = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userTimeZone")
Dim userType As String
userType = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userType")
Dim userUiSkin As String
userUiSkin = xmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userUiSkin")

Curl Command

curl -X POST
	-H "Content-Type: text/xml; charset=UTF-8"
	-H "SOAPAction: login"
	-H "Accept: text/xml"
	-d '<?xml version="1.0" encoding="utf-8" ?>
<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Body>
    <n1:login xmlns:n1="urn:partner.soap.sforce.com">
      <n1:username><![CDATA[{{username}}]]></n1:username>
      <n1:password><![CDATA[{{password}}{{secretToken}}]]></n1:password>
    </n1:login>
  </env:Body>
</env:Envelope>'
https://login.salesforce.com{{site}}/services/Soap/u/{{version}}

Postman Collection Item JSON

{
  "name": "SOAP Login",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const result = xml2Json(pm.response.text())[\"soapenv:Envelope\"][\"soapenv:Body\"].loginResponse.result;",
          "const url = result.serverUrl.split(\"/\");",
          "",
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "context.set(\"_accessToken\", result.sessionId);",
          "context.set(\"_endpoint\", url[0] + \"//\" + url[2]);",
          "context.set(\"_userId\", result.userId);",
          "context.set(\"_orgId\", result.userInfo.organizationId);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "text/xml; charset=UTF-8",
        "type": "text"
      },
      {
        "key": "SOAPAction",
        "value": "login",
        "type": "text"
      },
      {
        "key": "Accept",
        "value": "text/xml",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<env:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n    xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\">\n  <env:Body>\n    <n1:login xmlns:n1=\"urn:partner.soap.sforce.com\">\n      <n1:username><![CDATA[{{username}}]]></n1:username>\n      <n1:password><![CDATA[{{password}}{{secretToken}}]]></n1:password>\n    </n1:login>\n  </env:Body>\n</env:Envelope>"
    },
    "url": {
      "raw": "{{url}}{{site}}/services/Soap/u/{{version}}",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "Soap",
        "u",
        "{{version}}"
      ]
    },
    "description": "Logs in to the login server and starts a client session.\n\nMake sure to set the `url`, `username`, `password` and `secretToken` environment variables before sending this request.\nOn success, the request will automatically collect your authentication token for later use."
  },
  "response": [
    {
      "name": "Successful SOAP Login",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "text/xml",
            "type": "text"
          },
          {
            "key": "SOAPAction",
            "value": "login",
            "type": "text"
          },
          {
            "key": "charset",
            "value": "UTF-8",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<env:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n    xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\">\n  <env:Body>\n    <n1:login xmlns:n1=\"urn:partner.soap.sforce.com\">\n      <n1:username>demo@pozil.org</n1:username>\n      <n1:password>PASSWORD_GOES_HERE</n1:password>\n    </n1:login>\n  </env:Body>\n</env:Envelope>"
        },
        "url": {
          "raw": "https://login.salesforce.com/services/Soap/u/50.0",
          "protocol": "https",
          "host": [
            "login",
            "salesforce",
            "com"
          ],
          "path": [
            "services",
            "Soap",
            "u",
            "50.0"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "xml",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Jan 2021 12:47:25 GMT"
        },
        {
          "key": "X-B3-TraceId",
          "value": "facd9cec92dd7211"
        },
        {
          "key": "X-B3-SpanId",
          "value": "facd9cec92dd7211"
        },
        {
          "key": "X-B3-Sampled",
          "value": "0"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "text/xml; charset=utf-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns=\"urn:partner.soap.sforce.com\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <soapenv:Body>\n        <loginResponse>\n            <result>\n                <metadataServerUrl>https://pozil-dev-ed.my.salesforce.com/services/Soap/m/50.0/00D58000000arpq</metadataServerUrl>\n                <passwordExpired>false</passwordExpired>\n                <sandbox>false</sandbox>\n                <serverUrl>https://pozil-dev-ed.my.salesforce.com/services/Soap/u/50.0/00D58000000arpq</serverUrl>\n                <sessionId>SECRET_SESSION_ID_GOES_HERE</sessionId>\n                <userId>00558000000yFyDAAU</userId>\n                <userInfo>\n                    <accessibilityMode>false</accessibilityMode>\n                    <chatterExternal>false</chatterExternal>\n                    <currencySymbol>€</currencySymbol>\n                    <orgAttachmentFileSizeLimit>26214400</orgAttachmentFileSizeLimit>\n                    <orgDefaultCurrencyIsoCode>EUR</orgDefaultCurrencyIsoCode>\n                    <orgDefaultCurrencyLocale>fr_FR_EURO</orgDefaultCurrencyLocale>\n                    <orgDisallowHtmlAttachments>false</orgDisallowHtmlAttachments>\n                    <orgHasPersonAccounts>false</orgHasPersonAccounts>\n                    <organizationId>00D58000000arpqEAA</organizationId>\n                    <organizationMultiCurrency>false</organizationMultiCurrency>\n                    <organizationName>pozil DE</organizationName>\n                    <profileId>00e58000000wYTOAA2</profileId>\n                    <roleId xsi:nil=\"true\"/>\n                    <sessionSecondsValid>7200</sessionSecondsValid>\n                    <userDefaultCurrencyIsoCode xsi:nil=\"true\"/>\n                    <userEmail>demo@pozil.org</userEmail>\n                    <userFullName>Philippe Ozil</userFullName>\n                    <userId>00558000000yFyDAAU</userId>\n                    <userLanguage>en_US</userLanguage>\n                    <userLocale>fr_FR</userLocale>\n                    <userName>demo@pozil.org</userName>\n                    <userTimeZone>Europe/Paris</userTimeZone>\n                    <userType>Standard</userType>\n                    <userUiSkin>Theme3</userUiSkin>\n                </userInfo>\n            </result>\n        </loginResponse>\n    </soapenv:Body>\n</soapenv:Envelope>"
    }
  ]
}