Chilkat Online Tools

lianja / 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.

loHttp = createobject("CkHttp")

// 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>
// 

loXml = createobject("CkXml")
loXml.Tag = "env:Envelope"
loXml.AddAttribute("xmlns:xsd","http://www.w3.org/2001/XMLSchema")
loXml.AddAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance")
loXml.AddAttribute("xmlns:env","http://schemas.xmlsoap.org/soap/envelope/")
loXml.UpdateAttrAt("env:Body|n1:login",.T.,"xmlns:n1","urn:partner.soap.sforce.com")
loXml.UpdateChildContent("env:Body|n1:login|n1:username","{{username}}")
loXml.UpdateChildContent("env:Body|n1:login|n1:password","{{password}}{{secretToken}}")

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

loSbRequestBody = createobject("CkStringBuilder")
loXml.GetXmlSb(loSbRequestBody)

loResp = loHttp.PTextSb("POST","https://login.salesforce.com{{site}}/services/Soap/u/{{version}}",loSbRequestBody,"utf-8","text/xml; charset=UTF-8",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loXml
    release loSbRequestBody
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
release loResp

loXmlResponse = createobject("CkXml")
loXmlResponse.LoadSb(loSbResponseBody,.T.)
? loXmlResponse.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

lcSoapenv_Envelope_xmlns_soapenv = loXmlResponse.GetAttrValue("xmlns:soapenv")
lcSoapenv_Envelope_xmlns = loXmlResponse.GetAttrValue("xmlns")
lcSoapenv_Envelope_xmlns_xsi = loXmlResponse.GetAttrValue("xmlns:xsi")
lcMetadataServerUrl = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|metadataServerUrl")
lcPasswordExpired = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|passwordExpired")
lcSandbox = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|sandbox")
lcServerUrl = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|serverUrl")
lcSessionId = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|sessionId")
lcUserId = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userId")
lcAccessibilityMode = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|accessibilityMode")
lcChatterExternal = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|chatterExternal")
lcCurrencySymbol = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|currencySymbol")
lnOrgAttachmentFileSizeLimit = loXmlResponse.GetChildIntValue("soapenv:Body|loginResponse|result|userInfo|orgAttachmentFileSizeLimit")
lcOrgDefaultCurrencyIsoCode = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDefaultCurrencyIsoCode")
lcOrgDefaultCurrencyLocale = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDefaultCurrencyLocale")
lcOrgDisallowHtmlAttachments = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgDisallowHtmlAttachments")
lcOrgHasPersonAccounts = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|orgHasPersonAccounts")
lcOrganizationId = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationId")
lcOrganizationMultiCurrency = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationMultiCurrency")
lcOrganizationName = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|organizationName")
lcProfileId = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|profileId")
lcRoleId_xsi_nil = loXmlResponse.ChilkatPath("soapenv:Body|loginResponse|result|userInfo|roleId|(xsi:nil)")
lnSessionSecondsValid = loXmlResponse.GetChildIntValue("soapenv:Body|loginResponse|result|userInfo|sessionSecondsValid")
lcUserDefaultCurrencyIsoCode_xsi_nil = loXmlResponse.ChilkatPath("soapenv:Body|loginResponse|result|userInfo|userDefaultCurrencyIsoCode|(xsi:nil)")
lcUserEmail = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userEmail")
lcUserFullName = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userFullName")
lcUserId = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userId")
lcUserLanguage = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userLanguage")
lcUserLocale = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userLocale")
lcUserName = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userName")
lcUserTimeZone = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userTimeZone")
lcUserType = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userType")
lcUserUiSkin = loXmlResponse.GetChildContent("soapenv:Body|loginResponse|result|userInfo|userUiSkin")


release loHttp
release loXml
release loSbRequestBody
release loSbResponseBody
release loXmlResponse

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>"
    }
  ]
}