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