Page Comparison

...

• API outreach survey (2021)

• Swagger console page

  • updated version / example

• Europeana API documentation (Confluence)

• External - Europeana API documentation (Confluence)

• Europeana API forum

• For Developers page

• Debug menu enable page

• API Introduction Training draft document

• Europeana Learning Management System

• Slide deck - improving API onboarding (API key registration)

...

2. Their various needs/goals (in order of priority)

   1. “It’s something that we promised as part of an external project or tender”: Their org committed to connecting to our APIs and now they have to make it happen.

   2. Researcher: “I want data that's in the same data model that comes from different institutions” and Europeana is the only place they can access that.

   3. They have a startup idea and they want to use our APIs (e.g. Jama and his project Conzept)

   4. Educators showing their class how to use linked open data without having to pay for an API key.

3. Other tools/services we have for them, and where they are:

   1. APIs (currently on Pro), debug menu (currently in footer), etc

      1. API documentation on Pro will go away and it will become the Confluence documentation;

      2. Swagger consoles are a playground access to the API’s https://pro.europeana.eu/page/api-rest-console

         1. Could have more prominence on the page because it’s a cool feature, where you can play with the APIs easily; Swagger console output is a much easier way to view the API and learn how our website uses it in the backend.

         2. Either link to it from the page or embed it directly in the page. It’s more digestible bits of code that are much easier to use, and looks like this:

...

6. The needs of Jolan’s outreach efforts:

   1. How does he currently promote our APIs and other developer tools/features?

      1. They’re over marketed to ‘hey use our apis, use our data’ - so targeted physical outreach has been the most useful so far; conferences and hackathons where there’s a group of devs who are interested in the intersection of culture and development; this is more likely to get more people actually taking it up, following through, and making stuff.

      2. The onboarding steps he follows:

         1. gives a presentation,

         2. prompts them to browse the website and get inspired by objects,

         3. then he directs them to the debug page, and then they get a feel for what the data they're requesting looks like and how the requests work, get them inspired and the find something they want to use,

         4. and he directs them to the documentation most specific for their use case

      3. BIG LAUNCH OF HELP DOCUMENTATION IN FEB/MARCH SO IF THEY COINCIDE THAT WOULD BE NICE

   2. How would he use a page like this, once everything is in one place at one URL?

      1. This page would be between just surfing europeana.eu and then going into the deep documentation and active usage of our data; to help support this onboarding (above).

...