1. Jorrit Duin Avatar Jorrit Duin
  2. generic
  3. OCAPI

Wiki

Clone wiki

OCAPI / nl_indexController

View History

XML Index Controller

index

De indexController wordt niet vanuit het pakket aangeroepen

Dit request wordt niet door dgeDetailhandel / dgeGroothandel gebruikt, echter het is handig om te zien of een (OpenCart) configuratie door een klant goed is uitgevoerd. Een request naar de index geeft altijd response, echter wanneer de tokens worden meegegeven, dan wordt meer gedetailleerde informatie gegeven.

Er zijn alleen GET requests mogelijk naar de indexController

e.g.: xml request ocapi index

REQUEST: Met tokens

Een request met AUTH tokens geeft meer informatie. O.a. over de configuratie van in dit geval Opencart.

HEADERS
GET /ocapi/index.xml HTTP/1.1
x-auth-token: 1616279bab60275aca56fca86f80e56c
x-service-token: 555c7f149178099205edcc30
Host: jd.windev.nl
Connection: close

RESPONSE

HEADERS
HTTP/1.1 200 Ok
Date: Wed, 20 May 2015 13:58:01 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: OC Dge Driver (v2)
Transfer-Encoding: chunked
Connection: close
Content-Type: application/xml; charset=utf-8
CONTENT
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <service>
  <ep>http://jd.windev.nl/oc2/ocapi/</ep>
  <oc_version>2.0.0.0</oc_version>
  <api_version>2.0.1</api_version>
  <tax_class>
   <high>9</high>
   <low>9</low>
   <none>0</none>
  </tax_class>
  <length_class>
     <cm>
       <length_class_id>1</length_class_id>
       <value>1.00000000</value>
       <language_id>1</language_id>
       <title>Centimeter</title>
       <unit>cm</unit>
     </cm>
     <mm>
       <length_class_id>2</length_class_id>
       <value>10.00000000</value>
       <language_id>1</language_id>
       <title>Millimeter</title>
       <unit>mm</unit>
     </mm>
     <in>
       <length_class_id>3</length_class_id>
       <value>0.39370000</value>
       <language_id>1</language_id>
       <title>Inch</title>
       <unit>in</unit>
     </in>
  </length_class>
  <weight_class>
     <kg>
       <weight_class_id>1</weight_class_id>
       <value>1.00000000</value>
       <language_id>1</language_id>
       <title>Kilogram</title>
       <unit>kg</unit>
     </kg>
     <g>
       <weight_class_id>2</weight_class_id>
       <value>1000.00000000</value>
       <language_id>1</language_id>
       <title>Gram</title>
       <unit>g</unit>
     </g>
     <lb>
       <weight_class_id>5</weight_class_id>
       <value>2.20460000</value>
       <language_id>1</language_id>
       <title>Pound </title>
        <unit>lb</unit>
      </lb>
      <oz>
        <weight_class_id>6</weight_class_id>
        <value>35.27400000</value>
        <language_id>1</language_id>
        <title>Ounce</title>
        <unit>oz</unit>
      </oz>
    </weight_class>
    <order_status>
      <pending>
        <order_status_id>1</order_status_id>
        <name>Pending</name>
      </pending>
      <paid>
        <order_status_id>17</order_status_id>
        <name>paid</name>
      </paid>
      <processing>
        <order_status_id>2</order_status_id>
        <name>Processing</name>
      </processing>
      <complete>
        <order_status_id>5</order_status_id>
        <name>Complete</name>
      </complete>
      <canceled>
        <order_status_id>7</order_status_id>
        <name>Canceled</name>
      </canceled>
    </order_status>
  </service>
</response>

REQUEST: Zonder tokens

Een request met ZONDER tokens. Het ep veld (endpoint) laat de exacte url zien voor de API aanroepen. Let op de trailing slash

HEADERS
GET /ocapi/index.xml HTTP/1.1

RESPONSE

HEADERS
HTTP/1.1 200 Ok
Date: Wed, 20 May 2015 13:58:01 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: OC Dge Driver (v2)
Transfer-Encoding: chunked
Connection: close
Content-Type: application/xml; charset=utf-8
CONTENT
<response>
  <service>
    <ep>https://odemo.dgewebshopsystem.nl/ocapi/</ep>
    <oc_version>2.0.0.0</oc_version>
    <api_version>2.0.1</api_version>
  </service>
</response>

index

Updated