BioTime Cloud API DOCS

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/api/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

api-token-auth

create

POST /api-token-auth/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	Valid email for authentication
`password` required	Valid password for authentication
`company` required	Valid company for authentication

# Load the schema document
$ coreapi get /

# Interact with the API endpoint
$ coreapi action api-token-auth create -p email=... -p password=... -p company=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api-token-auth", "create"]
var params = {
    email: ...,
    password: ...,
    company: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("/")

# Interact with the API endpoint
action = ["api-token-auth", "create"]
params = {
    "email": ...,
    "password": ...,
    "company": ...,
}
result = client.action(schema, action, params=params)

jwt-api-token-auth

create

POST /jwt-api-token-auth/

use for cloud under mysite/api

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`company` required
`email` required
`password` required

# Load the schema document
$ coreapi get /

# Interact with the API endpoint
$ coreapi action jwt-api-token-auth create -p company=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jwt-api-token-auth", "create"]
var params = {
    company: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("/")

# Interact with the API endpoint
action = ["jwt-api-token-auth", "create"]
params = {
    "company": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

jwt-api-token-refresh

create

POST /jwt-api-token-refresh/

API View that returns a refreshed token (with new expiration) based on existing token

If 'orig_iat' field (original issued-at-time) is found, will first check if it's within expiration window, then copy it to the new token

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get /

# Interact with the API endpoint
$ coreapi action jwt-api-token-refresh create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jwt-api-token-refresh", "create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("/")

# Interact with the API endpoint
action = ["jwt-api-token-refresh", "create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

staff-api-token-auth

create

POST /staff-api-token-auth/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Valid username for authentication
`password` required	Valid password for authentication

# Load the schema document
$ coreapi get /

# Interact with the API endpoint
$ coreapi action staff-api-token-auth create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["staff-api-token-auth", "create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("/")

# Interact with the API endpoint
action = ["staff-api-token-auth", "create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

staff-jwt-api-token-auth

create

POST /staff-jwt-api-token-auth/

API View that receives a POST with a user's username and password.

Returns a JSON Web Token that can be used for authenticated requests.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`company` required
`username` required
`password` required

# Load the schema document
$ coreapi get /

# Interact with the API endpoint
$ coreapi action staff-jwt-api-token-auth create -p company=... -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["staff-jwt-api-token-auth", "create"]
var params = {
    company: ...,
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("/")

# Interact with the API endpoint
action = ["staff-jwt-api-token-auth", "create"]
params = {
    "company": ...,
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)