Back to top

agendakidsdigital.com

API

Sobre

Por meio de nossa API, as escolas podem refletir dados de qualquer software que utilizam e que tenha necessidade de informar/comunicar/engajar os usuários finais da plataforma (alunos e responsáveis).

Dentro desse universo será possível inicialmente o espelhamento de dados como: presenças/faltas do aluno (frequência do aluno ou lista de chamada); controle de acesso (aviso de entrada e saída de aluno); dados financeiros (cobranças e avisos importantes); relatórios diversos (que utilizem somente textos e links); ocorrências escolares; boletins/notas em conjunto ou individuais; avisos em geral (biblioteca, cantina entre outros).

Assim, escolas por meio da API podem espalhar dados que já possuem em seus ERP’s, de forma facilitada, evitando assim retrabalho e maximizando a eficiência dos profissionais que tem contato com a solução.

Central de notificações

Notificações

Criar notificação
POST/notifications

Campo Tipo Tamanho/Padrão Obrigatório Descrição
student_id Integer 11 Sim Identificador do aluno
student_see Boolean - Sim Informa se o aluno deverá visualizar a notificação
responsible_ids Array - Sim Identificador dos responsáveis
category String 255 Sim Categoria da notificação
  • gate
  • frequency
  • charging
  • reports
  • warnings
  • report_card
  • grades
  • absences
  • study_material
  • library
send_at Datetime - Sim Quando a notificação ocorreu?
title String 255 Sim Titulo da notificação
description Text - Sim Informações mais detalhadas sobre a notificação
from String 255 Sim Nome do seu sistema para que o usuário visualize de onde partiu a notificação

Example URI

POST https://api.agendaedu.com/v1/notifications
Request  Criar notificação somente para o aluno.
HideShow
Headers
Content-Type: application/json
x-school-token: <token da escola>
Body
{
  "student_id": 1942,
  "student_see": true,
  "responsible_ids": [],
  "category": "gate",
  "send_at": "2017-07-24 13:56:00",
  "title": "Titulo para catraca",
  "description": "Descrição para catraca",
  "from": "Pearson"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "student_id": {
      "type": "number",
      "description": "Identificador do registro de origem."
    },
    "student_see": {
      "type": "boolean",
      "description": "Informa se o aluno deverá visualizar a notificação ou não."
    },
    "responsible_ids": {
      "type": "array",
      "description": "Quando for somente o aluno, deixa o array vazio."
    },
    "category": {
      "type": "string",
      "enum": [
        "gate",
        "frequency",
        "charging",
        "reports",
        "warnings",
        "report_card",
        "grades",
        "absences",
        "study_material",
        "library"
      ],
      "description": "Categoria da notificação"
    },
    "send_at": {
      "type": "string",
      "description": "Data que a notificação ocorreu."
    },
    "title": {
      "type": "string",
      "description": "Titulo da notificação."
    },
    "description": {
      "type": "string",
      "description": "Descrição para a notificação."
    },
    "from": {
      "type": "string",
      "description": "Informe a origem de qual sistema está disparando a notificação."
    }
  },
  "required": [
    "student_id",
    "student_see",
    "responsible_ids",
    "category",
    "send_at",
    "title",
    "description",
    "from"
  ]
}
Request  Criar notificação somente para um ou mais responsáveis.
HideShow
Headers
Content-Type: application/json
x-school-token: <token da escola>
Body
{
  "student_id": 1942,
  "student_see": true,
  "responsible_ids": [
    11,
    32
  ],
  "category": "gate",
  "send_at": "2017-07-24 13:56:00",
  "title": "Titulo para catraca",
  "description": "Descrição para catraca",
  "from": "Pearson"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "student_id": {
      "type": "number",
      "description": "Identificador do registro de origem."
    },
    "student_see": {
      "type": "boolean",
      "description": "Informa se o aluno deverá visualizar a notificação ou não."
    },
    "responsible_ids": {
      "type": "array",
      "description": "Quando for somente o aluno, deixa o array vazio."
    },
    "category": {
      "type": "string",
      "enum": [
        "gate",
        "frequency",
        "charging",
        "reports",
        "warnings",
        "report_card",
        "grades",
        "absences",
        "study_material",
        "library"
      ],
      "description": "Categoria da notificação"
    },
    "send_at": {
      "type": "string",
      "description": "Data que a notificação ocorreu."
    },
    "title": {
      "type": "string",
      "description": "Titulo da notificação."
    },
    "description": {
      "type": "string",
      "description": "Descrição para a notificação."
    },
    "from": {
      "type": "string",
      "description": "Informe a origem de qual sistema está disparando a notificação."
    }
  },
  "required": [
    "student_id",
    "student_see",
    "responsible_ids",
    "category",
    "send_at",
    "title",
    "description",
    "from"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "created"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
Response  422
HideShow

A requisição foi concluída com sucesso, mas existem erros de semântica.

Headers
Content-Type: application/json
Body
{
  "student_id": 1942
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "student_id": {
      "type": "number",
      "description": "Identificador do registro de origem."
    }
  }
}
Response  400
HideShow

O pedido não pode ser entregue devido à sintaxe incorreta.

Generated by aglio on 08 Aug 2017