INSC ManualFundacoes » Histórico » Versão 3
Alexandre Menezes, 13/06/2017 08:49
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 | 1 | Alexandre Menezes | h3. Buscar todos os inscritos de uma determinada atividade |
31 | 1 | Alexandre Menezes | |
32 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/activities/XXX/participants, onde XXX é o _activity_code_ |
33 | 1 | Alexandre Menezes | *Tipo de request:* GET |
34 | 1 | Alexandre Menezes | *Parâmetros:* activity_key, token_key |
35 | 1 | Alexandre Menezes | *Retorno:* |
36 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
37 | 1 | Alexandre Menezes | |200|""|Lista de objetos JSON, contendo os seguintes atributos: enrolment_id, name, cpf, passport, email, mobile, phone| |
38 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
39 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
40 | 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)| |
41 | 1 | Alexandre Menezes | |404|Atividade não encontrada|Não existe atividade no sistema de inscrições com o código fornecido| |
42 | 1 | Alexandre Menezes | |
43 | 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.* |
44 | 1 | Alexandre Menezes | |
45 | 1 | Alexandre Menezes | *Exemplos:* |
46 | 1 | Alexandre Menezes | |
47 | 1 | Alexandre Menezes | resp = conn.get("/api/v1/activities/854/participants.json", "token_key" => "dcbb7b36acd4438d07abafb8e28605a4") |
48 | 1 | Alexandre Menezes | |
49 | 1 | Alexandre Menezes | resp.status |
50 | 1 | Alexandre Menezes | => 200 |
51 | 1 | Alexandre Menezes | |
52 | 1 | Alexandre Menezes | resp.body |
53 | 1 | Alexandre Menezes | => [{ |
54 | 1 | Alexandre Menezes | "enrolment_id":"1", |
55 | 1 | Alexandre Menezes | "name":"Fulano de Tal", |
56 | 1 | Alexandre Menezes | "cpf":"11122233344", |
57 | 1 | Alexandre Menezes | "passport":"", |
58 | 1 | Alexandre Menezes | "email":"fulano.de.tal@email.com", |
59 | 1 | Alexandre Menezes | "mobile":"(48) 91234-5678", |
60 | 1 | Alexandre Menezes | "phone":"(48) 3210-9876" |
61 | 1 | Alexandre Menezes | }, ...] |
62 | 1 | Alexandre Menezes | |
63 | 1 | Alexandre Menezes | resp = conn.get("/api/v1/activities/99/participants.json", "token_key" => "dcbb7b36acd4438d07abafb8e28605a4") |
64 | 1 | Alexandre Menezes | |
65 | 1 | Alexandre Menezes | resp.status |
66 | 1 | Alexandre Menezes | => 404 |
67 | 1 | Alexandre Menezes | |
68 | 1 | Alexandre Menezes | resp.body |
69 | 1 | Alexandre Menezes | => {"message":"Atividade não encontrada"} |
70 | 1 | Alexandre Menezes | |
71 | 1 | Alexandre Menezes | |
72 | 1 | Alexandre Menezes | |
73 | 1 | Alexandre Menezes | h3. Informar o pagamento de uma inscrição (ou parcela) |
74 | 1 | Alexandre Menezes | |
75 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/payment, onde XXX é o _enrolment_id_ |
76 | 1 | Alexandre Menezes | *Tipo de request:* POST |
77 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key, payment_amount,payment_date,payment_installment |
78 | 3 | Alexandre Menezes | |Parâmetro|Descrição|Observação| |
79 | 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.| |
80 | 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| |
81 | 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.| |
82 | 1 | Alexandre Menezes | |
83 | 1 | Alexandre Menezes | *Retorno:* |
84 | 1 | Alexandre Menezes | |
85 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
86 | 1 | Alexandre Menezes | |200|Pagamento registrado com sucesso|| |
87 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
88 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
89 | 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)| |
90 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
91 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
92 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
93 | 1 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |
94 | 1 | Alexandre Menezes | |
95 | 1 | Alexandre Menezes | |
96 | 1 | Alexandre Menezes | |
97 | 1 | Alexandre Menezes | h3. Aprovar (homologar) uma inscrição |
98 | 1 | Alexandre Menezes | |
99 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/approve, onde XXX é o _enrolment_id_ |
100 | 1 | Alexandre Menezes | *Tipo de request:* POST |
101 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key |
102 | 1 | Alexandre Menezes | |
103 | 1 | Alexandre Menezes | *Retorno:* |
104 | 1 | Alexandre Menezes | |
105 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
106 | 1 | Alexandre Menezes | |200|Inscrição homologada com sucesso|| |
107 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
108 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
109 | 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)| |
110 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
111 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
112 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
113 | 1 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |
114 | 1 | Alexandre Menezes | |
115 | 1 | Alexandre Menezes | |
116 | 1 | Alexandre Menezes | |
117 | 1 | Alexandre Menezes | |
118 | 1 | Alexandre Menezes | h3. Cancelar uma inscrição homologada |
119 | 1 | Alexandre Menezes | |
120 | 1 | Alexandre Menezes | *URL:* http://inscricoes.ufsc.br/api/v1/enroments/XXX/deny, onde XXX é o _enrolment_id_ |
121 | 1 | Alexandre Menezes | *Tipo de request:* POST |
122 | 1 | Alexandre Menezes | *Parâmetros:* activity_code, activity_key, token_key |
123 | 1 | Alexandre Menezes | |
124 | 1 | Alexandre Menezes | *Retorno:* |
125 | 1 | Alexandre Menezes | |
126 | 1 | Alexandre Menezes | |_.HTTP Status|_.Mensagem(message)|_.Descrição| |
127 | 1 | Alexandre Menezes | |200|Homologação de inscrição cancelada com sucesso|| |
128 | 1 | Alexandre Menezes | |401|API Token Inválido|O Token fornecido no webservice não existe cadastrado no sistema de inscrições| |
129 | 1 | Alexandre Menezes | |401|Acesso Negado.|O Token fornecido não possui permissão para executar a ação solicitada| |
130 | 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)| |
131 | 1 | Alexandre Menezes | |401|Acesso Negado: Inscrição não pertence a atividade informada|| |
132 | 1 | Alexandre Menezes | |401|Acesso Negado: Serviço não autorizado a acessar a atividade informada|| |
133 | 1 | Alexandre Menezes | |401|Acesso Negado: Chave de acesso não pertence a atividade informada|| |
134 | 1 | Alexandre Menezes | |404|Inscrição não encontrada|Não existe inscrição no sistema de inscrições com o código fornecido| |