API

As informações intelectuais aqui catalogadas são de caráter educativo e podem ser acessadas publicamente através deste site e integradas em outros aplicativos ou plataformas.

Para isso disponibilizamos a leitura desses dados através de uma API simples, em formato JSON.

Esta API não necessita de senha e pode ser utilizada livremente para leitura, sob a licença Creative Commons – Atribuição Não-Comercial.

No momento três leituras estão disponibilizadas:

1- Termos

Lista de todos os termos e seus atributos e relações.
https://oc.eca.usp.br/api/?terms

2- Relações

Lista dos tipos de relação atribuídos entre os termos.
https://oc.eca.usp.br/api/?relations

3- Top Terms

Lista dos Top Terms utilizados para classificar os termos.
https://oc.eca.usp.br/api/?top_terms

 

Descrição:

Obs.: Todos os atributos são catalogados com termos técnicos em inglês a fim de possibilitar universalidade nas implementações.

1- Termos

Amostra dos dados retornados:

https://oc.eca.usp.br/api/?terms
{
    "total_count": 241,
    "results": [
        {
            "name": "Analogia",
            "slug": "analogia",
            "top_term": "lo",
            "top_term_name": "Lógica",
            "relations": [
                {
                    "name": "Argumentos Indutivos",
                    "slug": "argumentos-indutivos",
                    "kind": "TG",
                    "weight": 4
                },
                {
                    "name": "Indução por Enumeração",
                    "slug": "inducao-por-enumeracao",
                    "kind": "TR",
                    "weight": 1
                },
                {
                    "name": "Silogismo Estatístico",
                    "slug": "silogismo-estatistico",
                    "kind": "TR",
                    "weight": 1
                }
            ],
            "definition": "Texto HTML da definição do termo.",
            "example": "Texto HTML do exemplo.",
            "ne": "Texto HTML da Nota de Escopo.",
            "videos": [
                {
                    "title": "Título do Vídeo de Exemplo",
                    "url": "https://oc.eca.usp.br/videos/video-de-exemplo/",
                    "content": "Texto HTML da descrição do vídeo.",
                    "video_url": "https://vimeo.com/12056223312",
                    "video_embed": "iframe para embed do vídeo",
                    "video_thumb": "https://oc.eca.usp.br/app/uploads/2015/03/508432290-1280-361x205.jpg"
                }
            ],
            "url": "https://oc.eca.usp.br/mapa/relacoes/analogia/"
        },
        ...
    ]
}

Descrição:

  • total_count: Indica a quantidade total de termos cadastrados no sistema.
  • results: Lista dos resultados, neste caso, os termos.
  • name: Nome do termo.
  • slug: Slug universal do termo, pode ser usado para traçar relações.
  • top_term: Slug do Top Term ao qual o termo se classifica.
  • top_term_name: Nome comum do Top Term.
  • relations: Lista de termos relacionados.
  • relations/name: Nome do termo relacionado.
  • relations/slug: Slug universal do termo relacionado.
  • relations/kind: Sigla do tipo de relação atribuído entre os termos.
  • relations/weight: Peso nominal dessa relação, de 1 à 4.
  • definition: Texto HTML da definição do termo.
  • example: Texto HTML do exemplo de uso do termo.
  • ne: Nota de Escopo do termo.
  • videos: Lista de vídeos relacionados à este termo.
  • videos/title: Título do Vídeo.
  • videos/url: Endereço da página do vídeo no site.
  • videos/content: Texto HTML da descrição do vídeo.
  • videos/video_url: Endereço da página do vídeo no YouTube, Vimeo, TED, etc.
  • videos/video_embed: Tag Iframe para embed do vídeo.
  • videos/video_thumb: Endereço para imagem do vídeo, JPG 361 x 205 px.
  • url: Endereço da página do termo no site.

 

2- Relações

Amostra dos dados retornados:

https://oc.eca.usp.br/api/?relations
{
    "total_count": 12,
    "results": [
        {
            "name": "Nota de Escopo",
            "slug": "ne"
        },
        ...
    ]
}

Descrição:

  • total_count: Indica a quantidade total de relações cadastrados no sistema.
  • results: Lista de resultados, neste caso, as relações.
  • name: Nome da relação.
  • slug: Slug universal da relação, pode ser usado para traçar relações.

 

3- Top Terms

Amostra dos dados retornados:

https://oc.eca.usp.br/api/?top_terms
{
    "total_count": 7,
    "results": [
        {
            "name": "Análise Documentária",
            "slug": "ad"
        },
        ...
    ]
}

Descrição:

  • total_count: Indica a quantidade total de Top Terms cadastrados no sistema.
  • results: Lista de resultados, neste caso, os Top Terms.
  • name: Nome do Top Term.
  • slug: Slug universal do Top Term, pode ser usado para traçar relações.