1. Driving Innovation V2 140508 Technology Strategy Board IC tomorrow Application Developer Overview

2. Driving Innovation IC tomorrow - what is it? A Digital Media/Service Trial Management platform for Content and Application Partners to: Access to a wide range of digital content to associate with your APP or service Access to an active community of complementary partners, to help you to launch A way to test out business propositions very easily Test your APP or service offering against a large test market

3. Driving Innovation Stakeholder Key Content Partner (CP) Application/Service Partner (ASP) Trial Manager (Trial Mgr) Test Bed Operator (Op) Consumers

4. Driving Innovation IP Networks IC tomorrow Platform Stakeholders Content Meta-Data Content Supply Agreements ServicesConsumer OffersConsumer Offers and associated Content Meta-Data Upload Content Meta-Data Create Content Supply Agreement Create Service Create Consumer Offer Discover Commercially Innovative Offers and their Associated Content

5. Driving Innovation Points to Note Services do not need to include content - they could simply be offering services The “actual” content is not served from IC tomorrow Consumers are likely to discover IC tomorrow offers via applications rather than the IC tomorrow portal itself

6. Driving Innovation V2 140508 Registering your Application

7. Driving Innovation Publishing your Application Register and join the _connect developer community Register and join IC tomorrow as an Application Partner Package your application or service for IC tomorrow to offer. Register your application or service for IC tomorrow. IC tomorrow helps you find complimentary digital content. IC tomorrow helps you construct a consumer offer. Consumers discover your Offer Consumers access your offer and their activity is logged in IC tomorrow via the application.

8. Driving Innovation V2 140508 Setting up the Minibar contest trials

9. Driving Innovation IC tomorrow Minibar Contest Entrants may submit work as an individual or as a group There are no restrictions on the number of APPs a person or group may submit All APPs submitted must be the work of the entrants themselves APPs must run using the IC tomorrow API’s APPs are to be hosted locally and not on the web Applicants must adhere to the T&C’s set out by IC Tomorrow

10. Driving Innovation IC tomorrow Minibar Contest You can use content meta-data that’s on the platform already You can reference external content You can use exclusive TSB loaded content from partners - such as Universal Music and Bridgeman Art Library Your application should not be published as a Live offer Entrants must register their APP on the IC tomorrow platform by 23rd November 2010 Entrants must be able to attend the show&tell on the 25th November where they will present their APP before our panel of judges

11. Driving Innovation V2 140508 API Summary

12. Driving Innovation IP Networks Test Bed Application API Call Stakeholders Obtain Consumer ID Obtain Consumer Key Sign up to Offer Consume within Offer Increment Meter Register Consumer Offer Record Consumer Activity

13. Driving Innovation IP Networks Test Bed Application API Call Stakeholders Search for Test Bed Offers Search How much more credit have I got? Get Meter I need to Top Up My Meter Update Meter Limits

14. Driving Innovation V2 140508 Where to get help

15. Driving Innovation Email Matt.Sansam@tsb.gov.uk info@openbusiness.cc TSB _connect group: https://ktn.innovateuk.org/web/minibar-ic-tomorrow-app- developers Metabroadcast Blog: http://metabroadcast.com/blog/ictomorrow-api-helper

16. Driving Innovation V2 140508 www.innovateuk.org

17. Driving Innovation V2 140508 Appendix A: IC tomorrow API Cheat Sheets

18. Driving Innovation API Cheat Sheets Provide a quick overview of calling the API – are not the full documentation All APIs: Are on http s ://api.ictomorrow.co.ukhttp s ://api.ictomorrow.co.uk Require basic authentication using your application key and password (created when you register your application) Cheat sheets: 1. Get Consumer ID 2. Register a consumer for an offer 3. Record a transaction 4. Search 5. Meter operations 6. Get content meta-data

19. Driving Innovation API cheat sheet 1a: Obtain Consumer ID API – Step 1 initiate Request Params – callBackUrl – URL on your site to redirect user back to after they have confirmed authorisation Response Codes 200 OK Sample Call PUT /v1.0/initiate HTTP/1.1 Authorization: BASIC QkVDRDg1RkEzMDRFNzFBQjpuaWtoaWw= Host: api.ictomorrow.co.uk Content-Length: 35 callBackUrl=http://ictest.yoururl.com Sample Response Output <?xml version="1.0" encoding="UTF-8"?> <token> <requestToken> 317 </requestToken> </token> Token value

20. Driving Innovation API cheat sheet 1b: Obtain Consumer ID API – Step 2 get customer to confirm registration Your application: Redirects user to: https://www.ictomottow.co.uk/auth/confirm?requestToken=[request token] e.g. https://www.ictomottow.co.uk/auth/confirm?requestToken=317 The user: Confirms whether they will allow your application can access their IC tomorrow account IC tomorrow: Redirects the user back to the call back URL supplied as part of the last stage Attached to this is the following parameter request: callbackConfirmed=true OR callbackConfirmed=false Token value

21. Driving Innovation API cheat sheet 1c: Obtain Consumer ID API – Step 3 exchange the token Request Params – Token – Token received in the last call Response Codes 200 OK 403 – Token does not match or Sample Call PUT /v1.0/Token HTTP/1.1 Authorization: BASIC MUEwOTY5NDBERUU5QjNDNTpwYXNzd29yZA== Host: api.ictomorrow.co.uk Content-Length: 15 requestToken= 317 Sample Response Output 419 Token value Consumer ID

22. Driving Innovation API cheat sheet 2: Register consumer for offer Request Params – Offer ID – get from the UI when you create your offer Consumer ID – get via the obtain consumer ID flow – see API cheat sheet 1 Response Codes 200 OK 404 – Offer or consumer does not exist Sample Call POST /v1.0/offers/515/users/419/register HTTP/1.1 Authorization: BASIC RTExODc1NDdDMDFCQUJEMzpwYXNzd29yZDI= Host: api.ictomorrow.co.uk Content-Length: 0 Sample Response Output true Consumer ID Offer ID

23. Driving Innovation API cheat sheet 3a: Record a transaction (1/2) Request Params – consumer_id – See API cheat sheet 1-3 application_key – Get when you register application offer_id – From UI when you create or view an offer trial_id – From UI when you create or view a trial activity_type – Free text value - optional transaction_date – Format 2010-09-21T15:59:19 (URL encoded) content_handle - From get content meta-data - optional increment_value – Value for your use - optional integer_value – Value for your use - optional free_text – Free text value for your use - optional

24. Driving Innovation API cheat sheet 3b: Record a transaction (2/2) Response Codes 200 OK Sample Call POST /v1.0/transaction HTTP/1.1 Authorization: Basic RjFFMjk1QkI3QzU0NjAyQTpwYXNzd29yZA== Host: api.ictomorrow.co.uk Content-Length: 185 offer_id=2&integer_value=1&trial_id=2&content_key=3&consumer_id=419&application_key=2&increment_value=1&transaction_d ate=2010-09-21T15%3A59%3A19Z&free_text=Test+message&activity_type=Consume Sample Response Output 10 https://www.innovateuk.org/survey?trial_id=1235&consumer_id=789

25. Driving Innovation API cheat sheet 4a: Search (1/2) Request Params – q – query string fq – sort – optional followed by a column name (see below) sort – optional format: [column name] [direction of sort] e.g. c_item_category_name_sort%20desc o_consumer_offer_name_sort%20desc o_consumer_offer_type_name_sort%20desc c_content_key_sort%20desc c_provider_name_sort%20desc o_consumer_offer_start_date%20desc Rows – optional – max # rows to return default / max = 50 Start – optional – start page in a multi-page result set Response Codes 200 OK

26. Driving Innovation API cheat sheet 4b: search (2/2) Sample Call GET /v1.0/query?q=find+me HTTP/1.1 Authorization: Basic NzhEM0E3MUZCQjkzNTIwNjpwYXNzd29yZA== Host: api.ictomorrow.co.uk Sample Response 0 * 1 Etc….

27. Driving Innovation API cheat sheet 5a: Get meter (1/3) Request Params – Offer ID – get from the UI when you create your offer Consumer ID – get via the obtain consumer ID flow – see API cheet sheet 1-3 Response Codes 200 OK 404 – Offer or consumer does not exist Sample Call GET https://api-testbed.testbeddev.com/v1.0/offers/515/users/419/meter HTTP/1.1 Authorization: BASIC 78D3A71FBB935206 Host: api.ictomorrow.co.uk Sample Response Output 10 7 true false false 15 10 20 9 Etc.. Consumer ID Offer ID

28. Driving Innovation API cheat sheet 5b: Increment meter (2/3) Request Params – Offer ID – get from the UI when you create your offer Consumer ID – get via the obtain consumer ID flow – see API cheet sheet 1-3 Update_type – Must be 0 Increment value – Value to increment the meter by (optional default 1, may be negative) Response Codes 200 OK 404 – Offer or consumer does not exist 403 – Invalid operation e.g. incrementing beyond meter limit – see returned text Sample Call PUT https://api-testbed.testbeddev.com/v1.0/offers/515/users/419/meter HTTP/1.1 Authorization: BASIC RTExODc1NDdDMDFCQUJEMzoxMjM= Host: api.ictomorrow.co.uk Content-Length: 34 update_type=0&increment_value=1 Sample Response Output As per get meter Consumer ID Offer ID

29. Driving Innovation API cheat sheet 5c: Update meter limits (3/3) Request Params – Offer ID – get from the UI when you create your offer Consumer ID – get via the obtain consumer ID flow – see API cheet sheet 1-3 Update_type – Must be 1 notification_update_amount maximum_update_amount Response Codes 200 OK 404 – Offer or consumer does not exist Sample Call PUT https://api-testbed.testbeddev.com/v1.0/offers/515/users/419/meter HTTP/1.1 Authorization: BASIC RTExODc1NDdDMDFCQUJEMzoxMjM= Host: api.ictomorrow.co.uk Content-Length: 71 update_type=1&notification_update_amount=10&maximum_update_amount=10 Sample Response Output As per get meter Consumer ID Offer ID

30. Driving Innovation API cheat sheet 6a – Get content meta-data – request your download Request Params – Optional from offer ID, CSA ID to scope the amount of content returned Response Codes 200 OK Sample Call POST /v1.0/content/request HTTP/1.1 Host: api.ictomorrow.co.uk Content-Length: 8 csa_id=1 Sample Response Output 7863 This response means you’ve requested a download, use the job ID to poll for it (see next page)

31. Driving Innovation API cheat sheet 6b – Get content meta-data – poll for and then get your download Request Params – Job_id – from your original request Response Codes 200 OK Sample Call GET /v1.0/content/get?job_id= 7863 HTTP/1.1 Authorization: BASIC RTExODc1NDdDMDFCQUJEMzoxMjM= Sample Response Output The content of one of the following In Progress The job ID is not recognised Not recognised The file has expired Expired

32. Driving Innovation V2 140508 Appendix B: Content Meta-Data

33. Driving Innovation What is the Test Bed’s approach to meta-data? All Content Upload packs must be in a XML format. All XML must have the following keys: Content Provider Name Item Key Title All the meta-data tags associated with a content category type are fully extensible Undefined meta-data tags and content categories can still be uploaded onto the Test Bed

34. Driving Innovation Example meta-data Winter Winds The Cave