ZfApi


Click here for a complete list of operations.

Authenticate

Finalizes login sequence and generates a authentication token. More...

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.zenfolio.com/api/1.6/Authenticate"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Authenticate xmlns="http://www.zenfolio.com/api/1.6">
      <challenge>base64Binary</challenge>
      <proof>base64Binary</proof>
    </Authenticate>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateResponse xmlns="http://www.zenfolio.com/api/1.6">
      <AuthenticateResult>string</AuthenticateResult>
    </AuthenticateResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/1.6/zfapi.asmx/Authenticate?challenge=string&challenge=string&proof=string&proof=string HTTP/1.1
Host: www.zenfolio.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.zenfolio.com/api/1.6">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx/Authenticate HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

challenge=string&challenge=string&proof=string&proof=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.zenfolio.com/api/1.6">string</string>


JSON-RPC

The following is a sample JSON-RPC request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/json
Content-Length: length

{
    "method": "Authenticate",
    "params": [challenge, proof],
    "id": id
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
    "result": value,
    "error": null,
    "id": id
}
Request
Response