API Reference | cleverbridge

Want to find out about the assortment of APIs that cleverbridge offers? The cleverbridge API Reference is the place to learn about our API resources, request items, and responses. You can also try out our endpoints using the API explorer.

Get Started    

Additional Examples - Generate Protected URL

<GenerateProtectedUrlRequest xmlns="http://api.cleverbridge.com/datacontract">
  <AllowToChangeCart>false</AllowToChangeCart>
  <MaxQuantity>10</MaxQuantity>
  <ResultItemQuantity>1</ResultItemQuantity>
  <TargetUrl>https://www.cleverbridge.com/864/?scope=checkout&cart=97770</TargetUrl>
  <ValidFrom>2016-01-01T00:00:00</ValidFrom>
  <ValidUntil>2020-01-01T00:00:00</ValidUntil>
</GenerateProtectedUrlRequest>
<?xml version="1.0"?>
<GenerateProtectedUrlResponse xmlns="http://api.cleverbridge.com/datacontract">
  <ResultMessage>OK</ResultMessage>
  <Items>
    <Item>
      <Identifier>u9j9dcpao0</Identifier>
      <Url>https://www.cleverbridge.com/864/uurl-u9j9dcpao0</Url>
    </Item>
  </Items>
</GenerateProtectedUrlResponse>
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://api.cleverbridge.com/datacontract" elementFormDefault="qualified" targetNamespace="http://api.cleverbridge.com/datacontract">
   <xs:element name="GenerateProtectedUrlRequest" nillable="true" type="tns:GenerateProtectedUrlRequest" />
   <xs:complexType name="GenerateProtectedUrlRequest">
      <xs:sequence>
         <xs:element minOccurs="1" maxOccurs="1" name="AllowToChangeCart" type="xs:boolean" />
         <xs:element minOccurs="1" maxOccurs="1" name="MaxQuantity" type="xs:long" />
         <xs:element minOccurs="1" maxOccurs="1" name="ResultItemQuantity" type="xs:long" />
         <xs:element minOccurs="0" maxOccurs="1" name="TargetUrl" type="xs:string" />
         <xs:element minOccurs="1" maxOccurs="1" name="ValidFrom" type="xs:dateTime" />
         <xs:element minOccurs="1" maxOccurs="1" name="ValidUntil" type="xs:dateTime" />
      </xs:sequence>
   </xs:complexType>
</xs:schema>
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://api.cleverbridge.com/datacontract" elementFormDefault="qualified" targetNamespace="http://api.cleverbridge.com/datacontract">
   <xs:element name="GenerateProtectedUrlResponse" nillable="true" type="tns:GenerateProtectedUrlResponse" />
   <xs:complexType name="GenerateProtectedUrlResponse">
      <xs:complexContent mixed="false">
         <xs:extension base="tns:BaseResponseMessage">
            <xs:sequence>
               <xs:element minOccurs="0" maxOccurs="1" name="Items" type="tns:ArrayOfUrlItem" />
            </xs:sequence>
         </xs:extension>
      </xs:complexContent>
   </xs:complexType>
   <xs:complexType name="BaseResponseMessage">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="ResultMessage" type="xs:string" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="ArrayOfUrlItem">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="unbounded" name="Item" nillable="true" type="tns:UrlItem" />
      </xs:sequence>
   </xs:complexType>
   <xs:complexType name="UrlItem">
      <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="Identifier" type="xs:string" />
         <xs:element minOccurs="0" maxOccurs="1" name="Url" type="xs:string" />
      </xs:sequence>
   </xs:complexType>
</xs:schema>