Bodo Tasche edited this page Apr 1, 2018 · 6 revisions

We offer a GraphQL based API for SignDict. You can explore the API here and play around with it.

An example query to search for all words containing "Zug":

{
  search(word: "Zug") {
    id
    text
    type
    currentVideo {
      videoUrl
      license
      copyright
      originalHref
      user {
        name
      }
    }
  }
}

If you use the API please make sure to respect the license of the videos and display it next to the video. For example with a link like this:

<a href='#{video.originalHref}'>#{video.copyright}</a> under 
<a href='https://creativecommons.org/licenses/#{video.license}'>#{video.license}</a>

Pease do not hotlink the content on the CDN, copy it and serve it with your own CDN. A link back to the page on SignDict would be great, too.

Entries

An entry contains of some metadata like text and type and the videos attached to it. You will find the currently highest voted video in currentVideo and all other videos in the videos attribute.

Questions? Ask them in our Gitter chat.

Thanks for reading the wiki. We always look for help. Details can be found here.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.