Starkey Foundation - Starkey Video : API Specification

This page last changed on Sep 02, 2014 by pablo.viquez.

Main Navigation

Home

Home - Development

Home - Discovery & Architectur- e

Home - Servers & Sysadmin

Home - Starkey Teaser

Development Menu

API Specificati- on

Brightcove Documentati- on

Expression Engine Core Changes

Expression Engine DB

Home - Development

Local Environment Setup

Notes & Development priorities

Points Flow

QA - Remote Debugging

Server Side Debugging

Server Side Models

Starkey Social Networks Accounts

Updating Local Environment

URLs, Views & Data Models

API Specification

The application makes usage of 2 APIs. One for the Laravel system, and another for the frontend pages.

Front-End API

This is the API expose to the client side.

Summary

Endpoint Params Description Requires User Authentication Implementation
( Pending / Completed )

/api/v1/projects

• page Page number starting at 1

• size Pagesize, number of elements to include (default 6) Retrieves the projects in a paginated way

No

/api/v1/user

None

Retrieves the user information and points

Yes

/api/v1/user/awards

Retrieves all user batches, achievements, stamps and awards

Yes

/api/v1/user/stamps

Retrieves all user stamps

Yes

/api/v1/user/passport/xx

• xx (int) Episode ID Where XX is the episode ID. Returns all information regarding the passport for the given episode

Yes

/api/v1/user/activity

• page Page number starting at 1

• size Pagesize, number of elements to include. Defaults to 15

• startdate Integer with timestamp (seconds) of the start date.

• orderby Which field to order by. Possible fields: id, awarded_date, defaults to id

• sortby Sorting option. Possible values: DESC, ASC, defaults to DESC Retrieves the user activity by pages or dates

No

/api/v1/reference

None

Retrieves the point award reference with all possible awards and reference codes

No

/api/v1/share

• **module **
  • page:url_title (applies to homepage, what-is-operation-change)
  • project:id
  • episode:id
  • episode:id:STORY_ID
    • STORY_ID Every story has an unique identifier, this is the one to sent to the server.
  • projects
  • episodes Retrieves the link to share and redirect to the specified module

No

/api/v1/share_completed

Same params as shared Completes the sharing process and awards the points to the user

No

/api/v1/authorize

None

Authorization for redeem points. Must be called prior any enpoint that requires authentication

Yes

/api/v1/project/join

• project int Project ID

• auth string Authorization code. This is given by the Authorization endpoint. Must be a brand new auth token.

• notifications int 1/0. Opt-in If the user wants to receive project notifications. Subscribe a user to the project

Yes

/api/v1/project/contribute

• auth Token given by the authorized endpoint

• contribution Integer value. Number of points to give

• project Integer value. Project ID to credit the points Contribute to a cause or project endpoint

Yes

/api/v1/trip/contribute

• auth Token given by the authorized endpoint

• contribution Integer value. Number of points to give

• trip Integer value. Trip ID to credit the points Contribute to a cause or trip endpoint

Yes

/api/v1/brightcove/ID

None

Retrieves the Brightcove video information

No

/api/v1/brightcove/video_search

• video_ids Comma separated brightcove video ids Retrieves the Brightcove video information for multiple files

No

/api/v1/episodes

None

Retrieve all episodes

No

/api/v1/episode/EPISODEID/view

Optional Parameter:

• module=XX Where XX is the content module ID

• clip=XX Where XX is the video clip ID Marks the given EPISODEID as watched

No

/api/v1/episode/EPISODEID/share

None

Marks the given EPISODEID as shared

No

/api/v1/clip/CLIP_FRIENDLY_URL

None

Retrieves the information for the given clip

No

In This Page

• API Specification
• Front-End API
  • Summary

Site Map

Document generated by Confluence on Sep 16, 2014 14:12