Partners API (Authenticated)

The LiveStories Partners API allows users to upload, update, download or delete datasets in a secure fashion to/from your account in LiveStories.

This API requires authentication with an API key that is available in your account on the team page in LiveStories. If you do not have an account in LiveStories and are simply looking to download public datasets published by a organization on the LiveStories platform, please refer to the Public API documentation instead.

Conventions

Endpoints adhere to the following conventions/principles.

JSON

Outputs are JSON-encoded.

Stateless

All endpoints are stateless, operating purely upon RESTful semantics.

Versioned

All endpoints are prefixed with the version they're applicable to.

Authentication

All endpoints on the LiveStories Partner API require authentication.

The authentication mechanism is based on signing every request to the Partners API using a key that is available on the Team page in your account, on the LiveStories platform. API keys are only available to team managers in LiveStories.

To enable the Partners API on your account, please contact support@livestories.com

Sample code showing how to sign each request is provided on the LiveStories Developers Github repository.

Encryption

All endpoints are available through https only, ensuring encryption during all exchanges.

Entities

All endpoints effectively perform operations on Datasets in your account on your behalf. Your identity is established through your API key.

All datasets exposed the following properties:

Entities

All endpoints effectively perform operations on Datasets in your account on your behalf. Your identity is established through your API key.

All datasets expose the following properties:

        {
        "id": "<Dataset UUID Identifier>",
        "version": "<Dataset UUID Version>",
        "name": "<Dataset Friendly Name>",
        "owner": "<User ID>",
        "team": "<Team ID>",
        "visibility": "<public|private>",
        "deleted": "<Deleted Date>",
        "created": "<Created Date>",
        "properties": { "description": "...", "key_words": [...],
        "contact_name": "...", "contact_email": [...],
        "publisher": "...", "source_url": "..."}
        }
    

Entity reference/identifier. Precise format of this field varies by entity type.

Example Value: xxxxxxxx

name

Entity description suitable for display as a formal name (e.g. "Calvert County, MD").

Example Value: Calvert County, MD

description

Verbose entity description.

Example Value: xxxxxxxxx

owner

User ID that designates the owner of the object in question. This entity is stripped from public responses.

Example Value: xxxxxxxxx

team

Team ID that designates the team to which the object is assigned. This entity is stripped from public responses.

Example Value: xxxxxxxxx

visibility

Whether a dataset is public or private.

Example Value: public

properties

Additional properties about a dataset. These include: publisher, description, key_words, contact_name, contact_email, source_url.

Example Value: {"description": "Obesity rate by city", "key_words": ["health"]}