9.1.1. Basic API Authentication

This is an example for how to authenticate against the SOAP API

9.1.1.1. Step 1 - Authenticate to the SOAP API via /auth

1
2
3
4
5
6
7
8
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip, deflate",
  "Connection": "keep-alive",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "password": "VGFuaXVtMjAxNSE=",
  "username": "QWRtaW5pc3RyYXRvcg=="
}
  • Response Headers:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "connection": "Keep-Alive",
  "content-encoding": "gzip",
  "content-length": "109",
  "content-type": "text/plain; charset=us-ascii",
  "date": "Sat, 05 Sep 2015 05:19:28 GMT",
  "keep-alive": "timeout=5, max=100",
  "server": "Apache",
  "strict-transport-security": "max-age=15768000",
  "vary": "Accept-Encoding",
  "x-frame-options": "SAMEORIGIN"
}

9.1.1.2. Step 2 - Get the server version via /info.json

1
2
3
4
5
6
7
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip, deflate",
  "Connection": "keep-alive",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "25-1571-cacee3f25c1c8f0954a8d3a0125a965aaab6514060dd84c20c9d510164ebaf477714a7041f3a9876d3214a4d007f78963258ec73468c56759a4c7cf00082fac0"
}
  • Response Headers:
1
2
3
4
5
6
7
8
9
{
  "connection": "Keep-Alive",
  "content-length": "207",
  "content-type": "text/html; charset=iso-8859-1",
  "date": "Sat, 05 Sep 2015 05:19:28 GMT",
  "keep-alive": "timeout=5, max=99",
  "server": "Apache",
  "x-frame-options": "SAMEORIGIN"
}

9.1.1.3. Step 3 - Get the server version via /info.json

1
2
3
4
5
6
7
8
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip, deflate",
  "Connection": "keep-alive",
  "Content-Length": "0",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "25-1571-cacee3f25c1c8f0954a8d3a0125a965aaab6514060dd84c20c9d510164ebaf477714a7041f3a9876d3214a4d007f78963258ec73468c56759a4c7cf00082fac0"
}
  • Response Headers:
1
2
3
4
{
  "content-length": "10254",
  "content-type": "application/json"
}

Footnotes

[1]this file automatically created by BUILD/build_api_examples.py