Introdução

A API do Catálogo de Tecnologias Assistivas para Surdos fornece acesso aos dados do catálogo, permitindo que desenvolvedores integrem as informações das tecnologias assistivas em suas próprias aplicações. Todos os endpoints são acessíveis via HTTP GET e retornam dados no formato JSON. O objetivo é facilitar o acesso a informações sobre tecnologias assistivas voltadas para surdos, organizadas em diferentes formatos e agrupamentos.

Caso tenha dúvidas ou sugestões sobre o uso ou conteúdo da API, entre em contato conosco.

Como Usar

Como esta é uma API estática, você pode fazer requisições diretamente usando ferramentas como fetch em JavaScript ou requests em Python. Abaixo estão exemplos de como acessar os dados:

JavaScript (fetch)

fetch('https://tasparasurdos.github.io/api/leitor-tela.json')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Erro:', error));
Python (requests)

import requests
response = requests.get('https://tasparasurdos.github.io/api/leitor-tela.json')
data = response.json()
print(data)

Substitua leitor-tela.json pelo slug da tecnologia desejada, que pode ser obtido no endpoint /indice.json.

Estrutura de Dados

Cada tecnologia individual contém os seguintes campos:

  • titulo: String - Nome da tecnologia
  • descricao: String - Descrição detalhada da tecnologia
  • orientacao: String - Instruções de uso
  • dicas: String - Dicas para melhor uso
  • etapas_justificativa: String - Justificativa pedagógica
  • imagem: String - URL da imagem (ex.: https://tasparasurdos.github.io/imagens/tec1.jpg)
  • categoria: String - Categoria da tecnologia
  • custo: String - Custo (ex.: "Gratuito", "Pago")
  • requer_internet: String - "Sim" ou "Não"
  • plataformas: String - Plataformas suportadas (separadas por vírgula)
  • autor: String - Autor da tecnologia
  • link: String - URL para mais informações
  • etapas: String - Etapas de ensino (separadas por ponto e vírgula)
Answered GET /indice.json
Descrição

Retorna uma lista de todas as tecnologias assistivas disponíveis no catálogo.

URL

https://tasparasurdos.github.io/api/indice.json

Parâmetros

Nenhum

Exemplo de Resposta
[
  {
    "titulo": "Tecnologia 1",
    "icone": "https://tasparasurdos.github.io/imagens/tec1-icon.jpg",
    "slug": "tec1",
    "custo": "Gratuito",
    "requer_internet": "Sim",
    "plataformas": "Web",
    "etapas": "Ensino Fundamental",
    "apresentacao": "Breve descrição",
    "link": "https://tasparasurdos.github.io/api/tec1.json"
  },
  {
    "titulo": "Tecnologia 2",
    "icone": "https://tasparasurdos.github.io/imagens/tec2-icon.jpg",
    "slug": "tec2",
    "custo": "Pago",
    "requer_internet": "Não",
    "plataformas": "Mobile",
    "etapas": "Ensino Médio",
    "apresentacao": "Outra breve descrição",
    "link": "https://tasparasurdos.github.io/api/tec2.json"
  }
]
GET /categorias.json
Descrição

Retorna as tecnologias agrupadas por categoria, incluindo descrições das categorias.

URL

https://tasparasurdos.github.io/api/categorias.json

Parâmetros

Nenhum

Exemplo de Resposta
{
  "Categoria 1": {
    "descricao": "Descrição da Categoria 1",
    "tecnologias": [
      {
        "titulo": "Tecnologia 1",
        "icone": "https://tasparasurdos.github.io/imagens/tec1-icon.jpg",
        "imagem": "https://tasparasurdos.github.io/imagens/tec1.jpg",
        "slug": "tec1"
      }
    ]
  },
  "Categoria 2": {
    "descricao": "Descrição da Categoria 2",
    "tecnologias": [
      {
        "titulo": "Tecnologia 2",
        "icone": "https://tasparasurdos.github.io/imagens/tec2-icon.jpg",
        "imagem": "https://tasparasurdos.github.io/imagens/tec2.jpg",
        "slug": "tec2"
      }
    ]
  }
}
GET /custo.json
Descrição

Retorna as tecnologias agrupadas por custo (gratuito, pago, etc.).

URL

https://tasparasurdos.github.io/api/custo.json

Parâmetros

Nenhum

Exemplo de Resposta
{
  "Gratuito": [
    {
      "titulo": "Tecnologia 1",
      "slug": "tec1"
    }
  ],
  "Pago": [
    {
      "titulo": "Tecnologia 2",
      "slug": "tec2"
    }
  ]
}
GET /etapas_ensino.json
Descrição

Retorna as tecnologias agrupadas por etapas de ensino (ex.: Ensino Fundamental, Médio).

URL

https://tasparasurdos.github.io/api/etapas_ensino.json

Parâmetros

Nenhum

Exemplo de Resposta
{
  "Ensino Fundamental": [
    {
      "titulo": "Tecnologia 1",
      "slug": "tec1"
    }
  ],
  "Ensino Médio": [
    {
      "titulo": "Tecnologia 2",
      "slug": "tec2"
    }
  ]
}
GET /requer_internet.json
Descrição

Retorna as tecnologias agrupadas por requisito de conexão à internet (Sim ou Não).

URL

https://tasparasurdos.github.io/api/requer_internet.json

Parâmetros

Nenhum

Exemplo de Resposta
{
  "Sim": [
    {
      "titulo": "Tecnologia 1",
      "slug": "tec1"
    }
  ],
  "Não": [
    {
      "titulo": "Tecnologia 2",
      "slug": "tec2"
    }
  ]
}
GET /plataformas.json
Descrição

Retorna as tecnologias agrupadas por plataformas suportadas (ex.: Web, Mobile).

URL

https://tasparasurdos.github.io/api/plataformas.json

Parâmetros

Nenhum

Exemplo de Resposta
{
  "Web": [
    {
      "titulo": "Tecnologia 1",
      "slug": "tec1"
    }
  ],
  "Mobile": [
    {
      "titulo": "Tecnologia 2",
      "slug": "tec2"
    }
  ]
}
GET /recursos.json
Descrição

Retorna uma lista de recursos adicionais relacionados ao catálogo.

URL

https://tasparasurdos.github.io/api/recursos.json

Parâmetros

Nenhum

Exemplo de Resposta
[
  {
    "titulo": "Recurso 1",
    "link": "https://exemplo.com/recurso1",
    "descricao": "Descrição do recurso 1"
  },
  {
    "titulo": "Recurso 2",
    "link": "https://exemplo.com/recurso2",
    "descricao": "Descrição do recurso 2"
  }
]
GET /<slug>.json
Descrição

Retorna os detalhes completos de uma tecnologia assistiva específica, identificada pelo seu slug. O slug pode ser obtido consultando o endpoint /indice.json.

URL

https://tasparasurdos.github.io/api/.json

Parâmetros

Nenhum

Exemplo

Para a tecnologia com slug "tec1":

https://tasparasurdos.github.io/api/tec1.json

Exemplo de Resposta
{
  "titulo": "Tecnologia 1",
  "descricao": "Descrição detalhada da tecnologia.",
  "orientacao": "Orientações para uso.",
  "dicas": "Dicas adicionais.",
  "etapas_justificativa": "Justificativa das etapas.",
  "imagem": "https://tasparasurdos.github.io/imagens/tec1.jpg",
  "categoria": "Categoria 1",
  "custo": "Gratuito",
  "requer_internet": "Sim",
  "plataformas": "Web",
  "autor": "Autor da tecnologia",
  "link": "Link para mais informações",
  "etapas": "Ensino Fundamental"
}

Suporte

Para dúvidas ou problemas com a API, por favor entre em contato pelo formulário do site.