INTRODUÇÃO AUTENTICAÇÃO. POST /api/oauth/token DOCUMENTAÇÃO API VERSÃO 3

Transcrição

1 INTRODUÇÃO A API SCOPI oferece a possibilade de integrar o seu SCOPI com outros sistemas, permitindo tanto consultar seus dados, quanto inserir e atualizar dados automaticamente. Neste documento você encontrará todas as informações necessárias para realizar qualquer requisição e integrar o SCOPI conforme suas necessades. O acesso a API é permito somente para clientes. Cada cliente possui uma credencial, que é utilizada para a autenticação na API. Ao fazer qualquer requisição, você precisa incluir um token oauth que é gerado a partir da sua credencial. Para gerar o token você utiliza a rota de autenticação, passando a sua credencial e recebendo o token. O token expira em 24 horas, após esse período, você precisa gerar um novo token para continuar. Para mais informações entre em contato com o suporte. AUTENTICAÇÃO POST /api/oauth/token Autentica o cliente a partir da sua credencial e retorna um token oauth. BODY PARAMS *grant_type *client_ *client_secret Tipo de acesso. Valor válo: client_credentials. Identificador do cliente. Token do cliente. curl -X POST ' \ -H 'content-type: application/json' \ -d ' "grant_type": "client_credentials", "client_": <<client_>>, "client_secret": <<client_secret>> ' "access_token": <<access_token>>, "token_type": "bearer", "expires_in": 86400, "created_at":

2 USUÁRIOS GET /users Retorna uma lista de usuários. QUERY PARAMS active boolean Busca usuários ativos/inativos. Valores válos: true ou false. ' [,, " ": "active": true "name": "Maria", " ": "active": true 2

3 DIVISÕES GET /divisions Retorna uma lista de divisões. ' [, "name": "Administração", "strategic_map": "name": "Empresa X ( )" "name": "Vendas", "strategic_map": "name": "Empresa X ( )" 3

4 OBJETIVOS GET /objectives Retorna uma lista de objetivos. QUERY PARAMS active boolean Busca objetivos ativos/inativos. Valores válos: true ou false. ' [, "name": "Ampliar a receita e o lucro", "strategic_map": "name": "Empresa X ( )" "name": "Melhorar as condições de infraestrutura", "strategic_map": "name": "Empresa X ( )" 4

5 INDICADORES GET /indicators Retorna uma lista de indicadores. QUERY PARAMS active boolean objective_ division_ coordinator_ responsible_ nivel Busca indicadores ativos/inativos. Valores válos: true ou false. Busca indicadores por objetivo estratégico. Valores válos: um ou mais entificadores separados por vírgula. Busca indicadores por divisão. Valores válos: um ou mais entificadores separados por vírgula. Busca indicadores por coordenador. Valores válos: um ou mais entificadores separados por vírgula. Busca indicadores por responsável. Valores válos: um ou mais entificadores separados por vírgula. Busca indicadores por nivel. Valores válos: um ou mais niveis separados por vírgula. Possíveis niveis: 0, 1, 2 ou 3. ' [ "name": "Faturamento", "description": "Receita bruta de vendas", "nivel": 3, "lines": 0, "division": "name": "Administração", "objective": "name": "Ampliar a receita e o lucro", "coordinator":, "responsible": "name": "Maria" 5

6 GET /indicators/: Retorna um único indicador. Identificador do indicador. ' "name": "Faturamento", "description": "Receita bruta de vendas", "nivel": 3, "measure_unit": "R$", "source": "Planilha", "tendency": 0, "relation": 0, "tolerance": 5, "lines": 0, "division": "name": "Administração", "objective": "name": "Ampliar a receita e o lucro", "coordinator":, "responsible": "name": "Maria", "series": [ "serie": "A", "name": "Faturamento", "year": 2017, "result": "value": , "goal": , "percentage": 100, "situation": "reached", 6

7 "lines": [ "line": 1, "category": "Janeiro", "result": "value": , "goal": , "percentage": 100, "situation": "reached",... PUT /indicators/: Atualiza dados do indicador. BODY PARAMS *serie *line value double goal double Identificador do indicador. Identificador da série. Possíveis séries: A, B, C, D, E ou F. Identificador da linha. Valor da linha. Meta da linha. curl -X PUT ' \ -H 'content-type: application/json' \ -d ' "access_token": <<access_token>>, "serie": "A", "line": 1, "value": " ,00" ' 7

8 PROJETOS GET /projects Retorna uma lista de projetos. QUERY PARAMS active boolean objective_ division_ coordinator_ sponsor_ nivel status Busca projetos ativos/inativos. Valores válos: true ou false. Busca projetos por objetivo estratégico. Valores válos: um ou mais entificadores separados por vírgula. Busca projetos por divisão. Valores válos: um ou mais entificadores separados por vírgula. Busca projetos por coordenador. Valores válos: um ou mais entificadores separados por vírgula. Busca projetos por patrocinador. Valores válos: um ou mais entificadores separados por vírgula. Busca projetos por nivel. Valores válos: um ou mais niveis separados por vírgula. Possíveis niveis: 0, 1, 2 ou 3. Busca projetos por status. Valores válos: um ou mais status separados por vírgula. Possíveis status: 1 (não iniciado), 2 (início atrasado), 3 (andamento no prazo), 4 (fim atrasado), 5 (concluído total), 6 (concluído parcial), 7 (cancelado). ' [ "name": "Construção de novo edifício", "description": "Novo edifício para a área administrativa", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": " ", "date_end": null, "status": 3, "division": "name": "Administração", "objective": "name": "Melhorar as condições de infraestrutura", "coordinator": 8

9 , "sponsor": "name": "Maria" GET /projects/: Retorna um único projeto. Identificador do projeto. ' "name": "Construção de novo edifício", "description": "Novo edifício para a área administrativa", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": " ", "date_end": null, "status": 3, "division": "name": "Administração", "objective": "name": "Melhorar as condições de infraestrutura", "coordinator":, "sponsor": "name": "Maria", "team": [ 9

10 , "name": "Maria", "justifications": [ "name": "O edifício atual não suporta adequadamente toda a equipe administrativa", "premises": [ "name": "Ter capacade para, no mínimo, uma equipe de 100 pessoas", "restrictions": [ "name": "O novo edifício deve ser sustentável", "risks": [ "name": "Cortes na equipe administrativa", "countermeasure": "A administração volta para o edifício atual e o novo edifício é alocado por outra área", "impact": 3, "probability": 1, "phases": [ "name": "TO DO", "description": null, "actions": [ "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": null, "date_end": null, "status": 1, "responsibles": [ 10

11 ,, "name": "DOING", "description": null, "actions": [ "": 3, "name": "DONE", "description": null, "actions": [, "expenses": [ "name": "Compra do terreno", "expected_date": " ", "expected_value": " ", "date": " ", "value": " ", "responsible": "name": "Maria", "revenues": [ "name": "Orçamento inicial", "expected_date": " ", "expected_value": " ", "date": " ", "value": " ", "responsible": "name": "Maria" GET /projects/:/team Retorna uma lista de membros da equipe do projeto. Identificador do projeto. 11

12 ' [, "name": "Maria" GET /projects/:/phases Retorna uma lista de fases do projeto. Identificador do projeto. QUERY PARAMS active boolean Busca fases ativas/inativas. Valores válos: true ou false. ' [ "name": "TO DO", "description": null, "actions": [ "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": null, "date_end": null, "status": 1, 12

13 ,, "responsibles": [ "name": "DOING", "description": null, "actions": [ "": 3, "name": "DONE", "description": null, "actions": [ POST /projects/:/phases Cria uma fase no projeto. Identificador do projeto. BODY PARAMS *name description active boolean Nome da fase. Descrição da fase. Determina a fase ativa ou inativa curl -X POST ' \ -H 'content-type: application/json' \ -d ' "access_token": <<access_token>>, "name": "TO DO" ' 13

14 PROCESSOS O módulo de processos possui as mesmas rotas que o módulo de projetos, substituindo "/projects" por "/processes": GET /processes GET /processes/: GET /processes/:/team GET /processes/:/phases POST /processes/:/phases 14

15 FASES GET /phases/: Retorna uma única fase. Identificador da fase. ' "name": "TO DO", "description": null, "project": "name": "Construção de novo edifício", "actions": [ "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": null, "date_end": null, "status": 1, "responsibles": [ PUT /phases/: Atualiza dados da fase. Identificador da fase. 15

16 BODY PARAMS name description active boolean Nome da fase. Descrição da fase. Determina a fase ativa ou inativa curl -X PUT ' \ -H 'content-type: application/json' \ -d ' "access_token": <<access_token>>, "active": true ' GET /phases/:/actions Retorna uma lista de ações da fase. QUERY PARAMS active boolean nivel status Identificador da fase. Busca ações ativas/inativas. Valores válos: true ou false. Busca ações por nivel. Valores válos: um ou mais niveis separados por vírgula. Possíveis niveis: 0, 1, 2 ou 3. Busca ações por status. Valores válos: um ou mais status separados por vírgula. Possíveis status: 1 (não iniciado), 2 (início atrasado), 3 (andamento no prazo), 4 (fim atrasado), 5 (concluído), 6 (cancelado). ' [ "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": null, 16

17 "date_end": null, "status": 1, "responsibles": [ POST /phases/:/actions Cria uma ação na fase. Identificador da fase. BODY PARAMS *name description nivel prevision_start date prevision_end date date_start date date_end date responsible_ active boolean Nome da ação. Descrição da ação. Nivel da ação. Previsão de início da ação. Previsão de fim da ação. Data de início da ação. Data de fim da ação. Usuários responsáveis da ação. Valores válos: um ou mais entificadores separados por vírgula. Determina a ação ativa ou inativa. curl -X POST ' \ -H 'content-type: application/json' \ -d ' "access_token": <<access_token>>, "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", 17

18 ' "prevision_end": " " 18

19 AÇÕES GET /actions/: Retorna uma única ação. Identificador da ação. ' "name": "Contratação de empreiteira", "description": "Contatar empreiteiras quanto ao orçamento e contratar", "nivel": 3, "prevision_start": " ", "prevision_end": " ", "date_start": null, "date_end": null, "status": 1, "project": "name": "Construção de novo edifício", "phase": "name": "TO DO", "responsibles": [, "comments": [ "comment": "Nova empreiteira contatada!", "user": "João" PUT /actions/: Atualiza dados da ação. 19

20 BODY PARAMS name description nivel prevision_start date prevision_end date date_start date date_end date responsible_ active boolean Identificador da ação. Nome da ação. Descrição da ação. Nivel da ação. Previsão de início da ação. Previsão de fim da ação. Data de início da ação. Data de fim da ação. Usuários responsáveis da ação. Valores válos: um ou mais entificadores separados por vírgula. Determina a ação ativa ou inativa. curl -X PUT ' \ -H 'content-type: application/json' \ -d ' "access_token": <<access_token>>, "active": true ' 20