Release 0.5 Pedro Vasconcelos

solaredx Documentation

Release 0.5 Pedro Vasconcelos

April 29, 2014

Contents

1 ?ndice

3

1.1 Instala??o e Configura??o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 API-v1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.3 Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.4 Outras informa??es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

i

ii

solaredx Documentation, Release 0.5

SolarEDX ? um pacote Python, plugavel ao EDX, que permite sua integra??o com o Solar. Esse pacote implementa, dentre outros recursos, uma API que permite o Solar controlar o EDX. A??es como criar cursos, usu?rios, gerenciar matr?culas, alocar professores e tutores pondem ser realizadas pela API.

Contents

1

solaredx Documentation, Release 0.5

2

Contents

CHAPTER 1

?ndice

1.1 Instala??o e Configura??o

Instalar e configurar o SolarEDX na sua instala??o EDX ? simples. Veja abaixo:

1.1.1 Instala??o

1. Instale a depend?ncia abaixo: ? django-tastypie 0.9.16 ()

Note: Observe que a vers?o do Tastypie (django-tastypie) n?o ? a mais recente. Isso ocorre porqu?, na ?poca do desenvolvimento do SolarEDX, o EDX utilizava o Django 1.4 (a qual ? suportada apenas pelo Tastypie 0.9.16 ou anteriores). 2. Instale o SolarEDX a partir do GitHub. $ pip install git+git://wwagner33/django-solaredx.git

1.1.2 Configura??o

Siga os passos abaixo para configura??o do SolarEDX na instala??o do EDX: 1. Inclua as vari?veis abaixo no arquivo de configura??o do CMS: AUTHENTICATION_BACKENDS = ('solaredx.backends.SolarEDXBackend', ) INSTALLED_APPS += ('tastypie', 'solaredx', ) TASTYPIE_DEFAULT_FORMATS = ['json'] TASTYPIE_DATETIME_FORMATTING = 'rfc-2822' SOLAREDX_SECRET_KEY = 'your secret key' 2. Inclua as URLs do SolarEDX no arquivo de configura??o de URLs do CMS: url(r'^solaredx/', include('solaredx.urls'))

3

solaredx Documentation, Release 0.5

1.2 API-v1

Essa documenta??o cobre a vers?o v1 da API. Todas as chamadas dessa vers?o cont?m, /api/v1/ na URI. Note: Uma regra geral ? que todas as requisi??es de consulta/leitura dever?o ser realizadas com HTTP GET, e as requisi??es de modifica??o/escrita com HTTP POST, PATCH ou DELETE para cria??o, modifica??o ou exclus?o, respecitvamente. Todas as requisi??es retornam o status_code mais adequado o poss?vel. Para mais informa??es consulte o artigo Status Code Definitions.

Note: Utilize o Curl ou a extens?o Postman do Chrome para "brincar" com a API enquanto voc? l? essa documenta??o.

Note: Embora fa?a parte do pacote SolarEDX, o sistema de login via Solar n?o est? implementado nessa API. O motivo principal ? que a arquitetura do Sistema de Login Simplificado quebra os princ?pios utilizados na API.

1.2.1 Introdu??o

A API provida pelo SolarEDX permite as seguintes chamadas: Chamadas relacionadas ? usu?rios:

? Criar usu?rios; ? Listar usu?rios; ? Consultar um usu?rio; ? Atualizar um usu?rio; ? Listar cursos em que o usu?rio est? matriculado; ? Matricular e desmatricular usu?rios; Chamadas relacionadas ? cursos: ? Criar cursos; ? Listar cursos; ? Consultar um curso; ? Deletar um curso; ? Listar professores e tutures de um curso; ? Associar professores e tutores ? um curso; ? Desassociar professores e tutores ? um curso;

1.2.2 Sistema de Seguran?a / Autentica??o

Uma vez que a API provida pelo SolarEDX permite a??es globais de controle e, em decorr?ncia disso, o acesso ser? restrito ? apenas clientes autorizados e com IP fixo (por exemplo, o servidor do Solar). Nesse caso, a restri??o de acesso dever? ser configurada no servidor do EDX, de modo a bloquear qualquer requisi??o ? API que venha de um IP n?o autorizado.

Note: O m?dulo ngx_http_access_module permite a instala??o desse sistema de seguran?a com o Nginx.

4

Chapter 1. ?ndice

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download