Kashoo API Documentation

/authTokens

The following operations are supported on this resource:

POST

Create a new auth token for use in subsequent requests.
You can pass form parameters email and password to send the username and password for login.
Tou can also use HTTP Auth Basic to pass the username and password in the Authorization HTTP header, this will parse that and return the new auth token for you.
To extend an existing token you can pass that in the Authorization header.

Parameters

name description type default
site (no documentation provided) form www.kashoo.com
lc (no documentation provided) form en_US
duration How long the auth token should take to expire, in milliseconds. Defaults to 24 hours. form 86400000
restriction Optional restriction on the token; restricted tokens are a bit safer to share with others form
email Email address of the user to login as form
password User's password; if not provided, an appropriate Authorization: header is expected form

Output Payload

element produceable content type(s)
authToken (XML)
  • application/xml
  • application/json
  • application/vnd.kashoo.authtoken+xml
  • application/vnd.kashoo.authtoken+json
description
The new auth token for use in future requests.

POST

Create a new auth token for use in subsequent requests, returning it as a UUID.
You can pass form parameters email and password to send the username and password for login.
Tou can also use HTTP Auth Basic to pass the username and password in the Authorization HTTP header, this will parse that and return the new auth token for you.
To extend an existing token you can pass that in the Authorization header.

Parameters

name description type default
site (no documentation provided) form www.kashoo.com
lc (no documentation provided) form en_US
duration How long the auth token should take to expire, in milliseconds form 86400000
restriction Optional restriction on the token; restricted tokens are a bit safer to share with others form
email Email address of the user to login as form
password User's password; if not provided, an appropriate Authorization: header is expected form

Output Payload

element produceable content type(s)
(custom)
  • text/plain
description
The new auth token for use in future requests.

GET

Login page if the browser comes here.

Output Payload

element produceable content type(s)
(custom)
  • text/html
description
(no documentation provided)

/authTokens

Home

REST Endpoints

SOAP Services

XML Data Elements

XML Data Types