pgo

README

pgo

Uma biblioteca para a API do Positivo On

Documentation

Index

• type Dados
• type DadosPrimitivos
  • func DadosUsuario(tokenLegada string) (*DadosPrimitivos, error)
• type ErroPrimitivo
• type ErroSenha
  • func AlterarSenha(antigaSenha, novaSenha, token string) (*ErroSenha, error)
  • func RecuperarSenha(userInfo string) (*ErroSenha, error)
• type InfoLivro
• type Item
  • func ObterLivros(token string) ([]Item, error)
• type Livro
• type LoginPrimitivoDadosEscola
• type LoginPrimitivoDadosSerie
• type LoginPrimitivoDadosTurma
• type LoginPrimitvoDadosUsuario
• type LoginUsuario
• type Recursos
  • func ObterRecursos(idEscola string, userToken string, tokenParceiro string) *Recursos
• type Schools
• type Token
  • func Login(username string, password string) (*Token, error)
• type TokenPrimitiva
  • func LegacyLogin(username string, password string) (*TokenPrimitiva, error)

Types

type Dados

type Dados struct {
	AccessToken         string    `json:"access_token"`          //Token de acesso e atividades no Studos.
	AccessTokenParceiro string    `json:"access_token_parceiro"` //Usado para as comunicações
	Alias               string    `json:"alias"`
	ExpiresIn           int       `json:"expires_in"`
	TokenType           string    `json:"token_type"`
	RefreshToken        string    `json:"refresh_token"`
	Scope               string    `json:"scope"`
	Schools             []Schools `json:"schools"`
}

type DadosPrimitivos

type DadosPrimitivos struct {
	Nome            string
	IdUsuarioEscola string
}

func DadosUsuario

func DadosUsuario(tokenLegada string) (*DadosPrimitivos, error)

type ErroPrimitivo

type ErroPrimitivo struct {
	Error            string `json:"error"`
	ErrorDescription string `json:"error_description"`
}

type ErroSenha

type ErroSenha struct {
	Erro     bool   `json:"error"`
	Conteudo bool   `json:"content"`
	Mensagem string `json:"errorMessage"`
}

func AlterarSenha

func AlterarSenha(antigaSenha, novaSenha, token string) (*ErroSenha, error)

func RecuperarSenha

func RecuperarSenha(userInfo string) (*ErroSenha, error)

type InfoLivro

type InfoLivro struct {
	ComponenteCurricular string `json:"componenteCurricular"`
	Volume               string `json:"volume"`
	Tipo                 string `json:"tipo"`
	URL                  string `json:"caminho"`
}

type Item

type Item struct {
	ID                   string `json:"id"`
	Colecao              string `json:"colecao"`
	Serie                string `json:"serie"`
	ComponenteCurricular string `json:"componenteCurricular"`
	Volume               string `json:"volume"`
	Capa                 string `json:"capa"`
	NivelEnsinoBase      string `json:"nivelEnsinoBase"`
	SerieBase            string `json:"serieBase"`
	Estante              string `json:"estante"`
	URL                  string `json:"caminho"`
	Tipo                 string `json:"tipo"`
	Arquivos             []struct {
		IDArquivo string `json:"idArquivo"`
		Tipo      string `json:"tipo"`
		Caminho   string `json:"caminho"`
	} `json:"arquivos"`
}

func ObterLivros

func ObterLivros(token string) ([]Item, error)

type Livro

type Livro struct {
	ComponenteCurricular string `json:"componenteCurricular"`
	Volume               string `json:"volume"`
	Arquivos             []struct {
		Tipo      string `json:"tipo"`
		IDArquivo string `json:"idArquivo"`
		Caminho   string `json:"caminho"`
	} `json:"arquivos"`
}

TYPES DOS LIVROS

type LoginPrimitivoDadosEscola

type LoginPrimitivoDadosEscola struct {
	ID            string   `json:"id"`
	IntegrationID string   `json:"integration_id"`
	UserID        string   `json:"user_id"`
	Name          string   `json:"name"`
	Roles         []string `json:"roles"`
	TimeZone      string   `json:"time_zone"`
	URL           string   `json:"url"`
}

type LoginPrimitivoDadosSerie

type LoginPrimitivoDadosSerie []struct {
	Value string                     `json:"value"`
	Label string                     `json:"label"`
	Turma []LoginPrimitivoDadosTurma `json:"turmas"`
}

type LoginPrimitivoDadosTurma

type LoginPrimitivoDadosTurma struct {
	NomeTurma   string `json:"nomeTurma"`
	TurmaValida bool   `json:"turmaValida"`
	NomeSerie   string `json:"nomeSerie"`
}

type LoginPrimitvoDadosUsuario

type LoginPrimitvoDadosUsuario struct {
	Sub                       string `json:"sub"`
	AuthTime                  int    `json:"auth_time"`
	Idp                       string `json:"idp"`
	Name                      string `json:"name"`
	Username                  string `json:"username"`
	Email                     string `json:"email"`
	IntegrationID             string `json:"integration_id"`
	Amr                       string `json:"amr"`
	LoginPrimitivoDadosEscola string `json:"schools"`
}

type LoginUsuario

type LoginUsuario struct {
	Sucesso  bool   `json:"sucesso"`  //true ou false
	Mensagem string `json:"mensagem"` //mensagem do resultado do login
	Dados    Dados  `json:"dados"`    //pode retornar uma string
}

TYPES DO LOGIN

type Recursos

type Recursos struct {
	Mensagens   string
	Agenda      string
	Atendimento string
	Studos      string
}

func ObterRecursos

func ObterRecursos(idEscola string, userToken string, tokenParceiro string) *Recursos

type Schools

type Schools struct {
	ID            string      `json:"id"`
	IntegrationID interface{} `json:"integration_id"`
	UserID        string      `json:"user_id"`
	Name          string      `json:"name"`
	Roles         []string    `json:"roles"`
}

type Token

type Token struct {
	Token         string
	TokenParceiro string
	IdEscola      string
	NomeEscola    string
	IdUsuario     string
}

func Login

func Login(username string, password string) (*Token, error)

type TokenPrimitiva

type TokenPrimitiva struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
	Expiration   int    `json:"expires_in"`
	TokenType    string `json:"token_type"`
}

func LegacyLogin

func LegacyLogin(username string, password string) (*TokenPrimitiva, error)