INSC ManualFundacoes » Histórico » Versão 12
Alexandre Menezes, 16/08/2017 14:06
1 | 1 | Alexandre Menezes | h1. Manual para Fundações (Escola de Extensão) |
---|---|---|---|
2 | 1 | Alexandre Menezes | |
3 | 1 | Alexandre Menezes | {{toc}} |
4 | 1 | Alexandre Menezes | |
5 | 1 | Alexandre Menezes | h2. Pré-requisito: token_key |
6 | 1 | Alexandre Menezes | |
7 | 1 | Alexandre Menezes | Antes de mais nada, é preciso registrar a Fundação junto ao Sistema de Inscrições, solicitando um token_key para utilizar os Webservices disponíveis. |
8 | 1 | Alexandre Menezes | Para solicitar, abrir um chamado em http://atendimento.setic.ufsc.br, com Service: Sistema de Inscrições. |
9 | 1 | Alexandre Menezes | |
10 | 2 | Alexandre Menezes | h2. Ambiente de Homologação |
11 | 2 | Alexandre Menezes | |
12 | 2 | Alexandre Menezes | Para os testes, usar a URL: http://staging.inscricoes.ufsc.br |
13 | 2 | Alexandre Menezes | |
14 | 2 | Alexandre Menezes | *IMPORTANTE:* o valor de _token_key_ é diferente para cada sistema (homologação e produção) |
15 | 2 | Alexandre Menezes | |
16 | 1 | Alexandre Menezes | h2. Integração com o SIGPEX |
17 | 1 | Alexandre Menezes | |
18 | 1 | Alexandre Menezes | Cada edição ofertada na Escola de Extensão, ao ser aprovada pela PROEX, tem dados da atividade no sistema de inscrições gravados no formulário do projeto, e devem ser acessadas pelo próprio SIGPEX. |
19 | 1 | Alexandre Menezes | |
20 | 1 | Alexandre Menezes | Dados obrigatórios nas chamadas dos webservices: |
21 | 1 | Alexandre Menezes | |
22 | 1 | Alexandre Menezes | |_.Rótulo do Campo no SIGPEX|_.Parâmetro passado no Webservice| |
23 | 1 | Alexandre Menezes | |Código da Atividade|activity_code| |
24 | 1 | Alexandre Menezes | |Chave de Acesso a atividade|activity_key| |
25 | 1 | Alexandre Menezes | |
26 | 1 | Alexandre Menezes | Juntamente com esses dois parâmetros, deve-se informar também o *token_key*, já devidamente registrado junto ao Sistema de Inscrições. |
27 | 1 | Alexandre Menezes | |
28 | 1 | Alexandre Menezes | h2. Serviços Disponíveis |
29 | 1 | Alexandre Menezes | |
30 | 10 | Alexandre Menezes | h3. Inscrever pessoa em uma atividade |
31 | 10 | Alexandre Menezes | |
32 | 10 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/activities/XXX/subscribe_person, onde XXX é o _activity_code_ |
33 | 10 | Alexandre Menezes | *Tipo de request:* POST |
34 | 10 | Alexandre Menezes | *Parâmetros:* activity_key, token_key, name, cpf, birthday, email, gender, mother_name, codigo_retorno |
35 | 10 | Alexandre Menezes | *Retorno:* |
36 | 10 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
37 | 10 | Alexandre Menezes | |200|""|Post feito com sucesso| |
38 | 10 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
39 | 10 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
40 | 10 | Alexandre Menezes | |401|Acesso Negado: Serviço ou chave da atividade direfente na atividade|A chave de acesso a atividade não está correta ou a fundação que está acessando a atividade não foi escolhida como administradora do curso (no SIGPEX)| |
41 | 10 | Alexandre Menezes | |404|Atividade não encontrada|Não existe atividade no sistema de inscrições com o código fornecido| |
42 | 10 | Alexandre Menezes | |
43 | 10 | Alexandre Menezes | *IMPORTANTE:* |
44 | 10 | Alexandre Menezes | * é imprescindível que haja um serviço criado pela fundação para que seja informado o número da inscrição (enrolment_id). |
45 | 10 | Alexandre Menezes | * o nome da pessoa e o nome da mãe não podem ter abreviações, pois caso contrário, não será salvo no cadastro da UFSC |
46 | 10 | Alexandre Menezes | |
47 | 10 | Alexandre Menezes | *WebService de Retorno* |
48 | 11 | Alexandre Menezes | Este é o WebService que deve ser implementado pela fundação |
49 | 10 | Alexandre Menezes | POST http://fundacao.org.br/path/subscription_return (codigo_retorno, enrolment_id) |
50 | 10 | Alexandre Menezes | |
51 | 1 | Alexandre Menezes | h3. Buscar todos os inscritos de uma determinada atividade |
52 | 1 | Alexandre Menezes | |
53 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/activities/XXX/participants, onde XXX é o _activity_code_ |
54 | 1 | Alexandre Menezes | *Tipo de request:* GET |
55 | 1 | Alexandre Menezes | *Parâmetros:* activity_key, token_key |
56 | 1 | Alexandre Menezes | *Retorno:* |
57 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
58 | 1 | Alexandre Menezes | |200|""|Lista de objetos JSON, contendo os seguintes atributos: enrolment_id, name, cpf, passport, email, mobile, phone| |
59 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
60 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
61 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço ou chave da atividade direfente na atividade|A chave de acesso a atividade não está correta ou a fundação que está acessando a atividade não foi escolhida como administradora do curso (no SIGPEX)| |
62 | 1 | Alexandre Menezes | |404|Atividade não encontrada|Não existe atividade no sistema de inscrições com o código fornecido| |
63 | 1 | Alexandre Menezes | |
64 | 1 | Alexandre Menezes | *IMPORTANTE: é imprescindível guardar o valor de enrolment_id, pois estes deve ser informado como parâmetro nos demais webservices relativos a inscrição.* |
65 | 1 | Alexandre Menezes | |
66 | 1 | Alexandre Menezes | *Exemplos:* |
67 | 1 | Alexandre Menezes | |
68 | 1 | Alexandre Menezes | resp = conn.get("/api/v1/activities/854/participants.json", "token_key" => "dcbb7b36acd4438d07abafb8e28605a4") |
69 | 1 | Alexandre Menezes | |
70 | 1 | Alexandre Menezes | resp.status |
71 | 1 | Alexandre Menezes | => 200 |
72 | 1 | Alexandre Menezes | |
73 | 1 | Alexandre Menezes | resp.body |
74 | 1 | Alexandre Menezes | => [{ |
75 | 1 | Alexandre Menezes | "enrolment_id":"1", |
76 | 7 | Alexandre Menezes | "status":"waiting_review", |
77 | 1 | Alexandre Menezes | "name":"Fulano de Tal", |
78 | 1 | Alexandre Menezes | "cpf":"11122233344", |
79 | 1 | Alexandre Menezes | "passport":"", |
80 | 1 | Alexandre Menezes | "email":"fulano.de.tal@email.com", |
81 | 1 | Alexandre Menezes | "mobile":"(48) 91234-5678", |
82 | 1 | Alexandre Menezes | "phone":"(48) 3210-9876" |
83 | 1 | Alexandre Menezes | }, ...] |
84 | 1 | Alexandre Menezes | |
85 | 1 | Alexandre Menezes | resp = conn.get("/api/v1/activities/99/participants.json", "token_key" => "dcbb7b36acd4438d07abafb8e28605a4") |
86 | 1 | Alexandre Menezes | |
87 | 1 | Alexandre Menezes | resp.status |
88 | 1 | Alexandre Menezes | => 404 |
89 | 1 | Alexandre Menezes | |
90 | 1 | Alexandre Menezes | resp.body |
91 | 1 | Alexandre Menezes | => {"message":"Atividade não encontrada"} |
92 | 1 | Alexandre Menezes | |
93 | 1 | Alexandre Menezes | |
94 | 1 | Alexandre Menezes | |
95 | 1 | Alexandre Menezes | h3. Informar o pagamento de uma inscrição (ou parcela) |
96 | 1 | Alexandre Menezes | |
97 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/payment, onde XXX é o _enrolment_id_ |
98 | 1 | Alexandre Menezes | *Tipo de request:* POST |
99 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key, payment_amount,payment_date,payment_installment |
100 | 4 | Alexandre Menezes | |_.Parâmetro|_.Descrição|_.Observação| |
101 | 3 | Alexandre Menezes | |payment_amount|Valor pago|A parte decimal do valor pago deve ser separada por ponto ("."). Ex. 145.44. Caso seja separado por vírgula (","), é considerada apenas a parte inteira do valor.| |
102 | 3 | Alexandre Menezes | |payment_date|Data do pagamento|São aceitos diversas formas de informar a data, menos timestamp. Ex. 09/06/2017 12:00:23 ou 2017-06-09 12:00:23 são válidas. Caso a data não seja "entendida", o campo fica com valor nulo| |
103 | 3 | Alexandre Menezes | |payment_installment|Número da parcela|São aceitos quaisquer valores para este campo. Sugere-se que pagamentos a vista, seja utilizado o valor 1, significando apenas uma parcela.| |
104 | 1 | Alexandre Menezes | |
105 | 1 | Alexandre Menezes | *Retorno:* |
106 | 1 | Alexandre Menezes | |
107 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
108 | 1 | Alexandre Menezes | |200|Pagamento registrado com sucesso|| |
109 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
110 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
111 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço ou chave da atividade direfente na atividade|A chave de acesso a atividade não está correta ou a fundação que está acessando a atividade não foi escolhida como administradora do curso (no SIGPEX)| |
112 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
113 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
114 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
115 | 1 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |
116 | 1 | Alexandre Menezes | |
117 | 1 | Alexandre Menezes | |
118 | 1 | Alexandre Menezes | |
119 | 1 | Alexandre Menezes | h3. Aprovar (homologar) uma inscrição |
120 | 1 | Alexandre Menezes | |
121 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/approve, onde XXX é o _enrolment_id_ |
122 | 1 | Alexandre Menezes | *Tipo de request:* POST |
123 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key |
124 | 1 | Alexandre Menezes | |
125 | 1 | Alexandre Menezes | *Retorno:* |
126 | 1 | Alexandre Menezes | |
127 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
128 | 1 | Alexandre Menezes | |200|Inscrição homologada com sucesso|| |
129 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
130 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
131 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço ou chave da atividade direfente na atividade|A chave de acesso a atividade não está correta ou a fundação que está acessando a atividade não foi escolhida como administradora do curso (no SIGPEX)| |
132 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
133 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
134 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
135 | 1 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |
136 | 1 | Alexandre Menezes | |
137 | 1 | Alexandre Menezes | |
138 | 1 | Alexandre Menezes | |
139 | 1 | Alexandre Menezes | |
140 | 1 | Alexandre Menezes | h3. Cancelar uma inscrição homologada |
141 | 1 | Alexandre Menezes | |
142 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/deny, onde XXX é o _enrolment_id_ |
143 | 1 | Alexandre Menezes | *Tipo de request:* POST |
144 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key |
145 | 1 | Alexandre Menezes | |
146 | 1 | Alexandre Menezes | *Retorno:* |
147 | 1 | Alexandre Menezes | |
148 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
149 | 1 | Alexandre Menezes | |200|Homologação de inscrição cancelada com sucesso|| |
150 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
151 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
152 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço ou chave da atividade direfente na atividade|A chave de acesso a atividade não está correta ou a fundação que está acessando a atividade não foi escolhida como administradora do curso (no SIGPEX)| |
153 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
154 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
155 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
156 | 5 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |
157 | 5 | Alexandre Menezes | |
158 | 6 | Alexandre Menezes | h2. Testes no Ambiente de Homologação |
159 | 5 | Alexandre Menezes | |
160 | 5 | Alexandre Menezes | Para poder testar no ambiente de homologação, foram criadas atividades com os seguintes dados |
161 | 5 | Alexandre Menezes | |
162 | 5 | Alexandre Menezes | |_.Fundação|_.Código da Atividade|_.Chave de Acesso da Atividade| |
163 | 5 | Alexandre Menezes | |FAPEU|116|2fb82c2ee46cf4c9e8845cbaff365875| |
164 | 5 | Alexandre Menezes | |FEESC|117|36de1619a87a6803ab50af076672f97d| |
165 | 5 | Alexandre Menezes | |FEPESE|118|189e725f4587b679740f0f7783745056| |
166 | 5 | Alexandre Menezes | |FUNJAB|119|0f393578a85c7c5fe754cf050968c26c| |
167 | 7 | Alexandre Menezes | |
168 | 7 | Alexandre Menezes | h2. Tabela de Status |
169 | 7 | Alexandre Menezes | |
170 | 8 | Alexandre Menezes | Esses valores são os possíveis quando retorna uma inscrição na chamada de listagem dos participantes de uma atividade |
171 | 8 | Alexandre Menezes | |
172 | 7 | Alexandre Menezes | |_.Status|_.Significado| |
173 | 7 | Alexandre Menezes | |enrolment_approved|Inscrição aprovada| |
174 | 7 | Alexandre Menezes | |enrolment_denied|Inscrição rejeitada| |
175 | 7 | Alexandre Menezes | |incomplete|Incompleta (faltam dados para os campos adicionais)| |
176 | 7 | Alexandre Menezes | |waiting_review|Aguardando análise| |
177 | 9 | Alexandre Menezes | |
178 | 9 | Alexandre Menezes | h2. Fluxo da Informação |
179 | 9 | Alexandre Menezes | |
180 | 9 | Alexandre Menezes | h3. 1º passo: registro da atividade de extensão e submissão ao edital |
181 | 9 | Alexandre Menezes | |
182 | 9 | Alexandre Menezes | Antes de mais nada, é preciso ter registrada a ação de extensão (SIGPEX) para poder concorrer ao edital da Escola de Extensão. Uma vez selecionado o projeto, seguem-se os demais passos. |
183 | 9 | Alexandre Menezes | |
184 | 9 | Alexandre Menezes | h3. 2º passo: criação da atividade no sistema de inscrições |
185 | 9 | Alexandre Menezes | |
186 | 9 | Alexandre Menezes | Num dos atributos que caracterizam a ação de extensão, é explicitado que o projeto se destina à Escola de Extensão. Desta forma, no SIGPEX, é mostrado um espaço exclusivo para a Escola de Extensão, onde a PROEX e as Fundações terão acesso. |
187 | 9 | Alexandre Menezes | Neste espaço, a PROEX deverá criar a atividade no sistema de inscrições por meio de um botão "Criar Atividade". São passados diversos parâmetros, entre eles, a fundação responsável por gerenciar a atividade. |
188 | 9 | Alexandre Menezes | Esta ação de criar atividade, além de criar uma atividade no sistema de inscrições, retorna o código e a chave de acesso da Atividade para que a fundação responsável possa gerenciar as inscrições. |
189 | 9 | Alexandre Menezes | |
190 | 9 | Alexandre Menezes | h3. 3º passo: formalização da atividade com a fundação |
191 | 9 | Alexandre Menezes | |
192 | 12 | Alexandre Menezes | Cria-se a atividade no sistema da fundação para a inscrição |
193 | 12 | Alexandre Menezes | |
194 | 12 | Alexandre Menezes | h3. 4º passo: fundação inscreve a pessoa na UFSC |
195 | 12 | Alexandre Menezes | |
196 | 12 | Alexandre Menezes | Fundação inscreve a pessoa na atividade do sistema de inscrições da UFSC por meio do webservice subscribe_person. |
197 | 12 | Alexandre Menezes | Sistema de inscrições retorna o código da inscrição (enrolment_id) para fundação em outro webservice. |
198 | 12 | Alexandre Menezes | |
199 | 12 | Alexandre Menezes | h3. 5º passo: fundação faz a gestão das inscrições |
200 | 12 | Alexandre Menezes | |
201 | 12 | Alexandre Menezes | - homologa inscrição |
202 | 12 | Alexandre Menezes | - cancela homologação |
203 | 12 | Alexandre Menezes | - informa pagamento |