Documentação Geral para Desenvolvedores versão 1.0

Transcrição

1 Documentação Geral para Desenvolvedores versão 1.0

2 Conteúdo 1 INTRODUÇÃO PLATAFORMA DE DESENVOLVEDORES VIVO PÚBLICO ALVO POR QUE É BETA? PASSOS INICIAIS DE UM DESENVOLVEDOR CADASTRO DO DESENVOLVEDOR AMBIENTES DE DESENVOLVIMENTO AMBIENTE SANDBOX AMBIENTE DE TESTING AMBIENTE COMERCIAL ACESSO AS APIs NA Plataforma de Desenvolvedores Vivo Página 2

3 1 INTRODUÇÃO 1.1 PLATAFORMA DE DESENVOLVEDORES VIVO A Plataforma de Desenvolvedores Vivo é uma iniciativa para impulsionar a inovação no que diz respeito ao desenvolvimento de aplicativos móveis. A comunidade de Desenvolvedores Vivo nasce com o objetivo de responder às mudanças e necessidades do mercado, criando um ecossistema de desenvolvimento que permite aos desenvolvedores obter os benefícios de um processo inovador, abrir novos mercados e gerar novas possibilidades de negócio, além de ampliar a oferta de aplicativos aos clientes. Aqui você encontrará um ambiente permanentemente dinâmico e participativo, que lhe proporciona valiosas ferramentas e apoio para impulsionar a sua criatividade. 1.2 PÚBLICO ALVO Tanto desenvolvedores como fãs de aplicativos móveis podem se cadastrar no portal, estabelecendo assim um ambiente de colaboração com o objetivo de diminuir o time to market e aumentar a rentabilidade com a criação de novos produtos e serviços. 1.3 POR QUE É BETA? A denominação Beta significa que a iniciativa da Plataforma de Desenvolvedores Vivo se encontra em um estado de evolução contínua e permanente, por isso a atual versão da comunidade não é definitiva. É nossa intenção melhorar o ambiente, avançar no processo de expansão de capacidades, proporcionar novas ferramentas úteis e inovadoras, melhorar os processos de inovação e comercialização de produtos dos nossos membros, etc. Esteja atento e colabore. A Plataforma de Desenvolvedores Vivo é uma comunidade aberta que aprecia a sua participação ativa: compartilhe as suas experiências de desenvolvimento, recomende que APIs devem estar disponíveis, quais são as suas linguagens favoritas, sugestões, propostas de melhoria, projetos, etc. As suas contribuições no Fórum são muito importantes. Página 3

4 2 PASSOS INICIAIS DE UM DESENVOLVEDOR 2.1 CADASTRO DO DESENVOLVEDOR Para se tornar um desenvolvedor é necessário primeiramente efetuar o cadastro na Plataforma de Desenvolvedores Vivo para poder usufruir os serviços oferecidos pela Vivo. O primeiro passo para o cadastro consiste em solicitar um convite no formulário de cadastro. Logo você vai receber um com um link para o formulário de ativação. Figura 1. Cadastrar-se como desenvolvedor na Plataforma de Desenvolvedores Vivo Clique no botão Cadastre-se na página Home para se cadastrar. Página 4

5 Figura 2. Solicitar um convite Na imagem a seguir é apresentado o formulário reduzido com os dados a serem preenchidos para a solicitação do convite. Página 5

6 Figura 3. Formulário de solicitação convite Uma vez preenchido o formulário resumido, o usuário receberá em sua conta de cadastrado um link para acessar a plataforma e concluir o processo de cadastro preenchendo as demais informações no formulário completo. Página 6

7 Página 7

8 Figura 4. Formulário completo de cadastro Após o preenchimento e envio do formulário completo o processo de cadastro é concluído e o usuário receberá um com sua senha de acesso a plataforma. Após receber o de confirmação de cadastro juntamente com sua senha, o desenvolvedor já pode entrar na área exclusiva para pessoas cadastradas. Página 8

9 Figura 5. Página de login do usuário cadastrado Digite seu login e senha para entrar na área exclusiva para desenvolvedores da Plataforma de Desenvolvedores Vivo. Página 9

10 3 AMBIENTES DE DESENVOLVIMENTO 3.1 AMBIENTE SANDBOX O ambiente sandbox existe especificamente para que um desenvolvedor possa testar as interfaces do seu aplicativo sem restrições. O acesso ao ambiente sandbox está aberto a todos os desenvolvedores do mundo e portanto não requer token de acesso para efetuar as requisições. Desta forma, para acessar o ambiente sandbox o desenvolvedor deve introduzir nas credenciais o spid, que o identifica como desenvolvedor na Plataforma e o serviceid que identifica o aplicativo. Como token pode ser introduzido qualquer valor, dado que o acesso ao ambiente sandbox é livre. Todas as requisições geradas para o ambiente de sandbox não provocam tráfico real e, portanto, não são tarifadas. 3.2 AMBIENTE DE TESTING Em breve estará disponível. 3.3 AMBIENTE COMERCIAL Em breve estará disponível. Página 10

11 4 Acesso as APIs na Plataforma de Desenvolvedores Vivo As chamadas às API que a Plataforma de Desenvolvedores Vivo oferece devem levar um cabeçalho de autenticação em cada requisição HTTP que seja realizada. No cabeçalho deve vir incluída a informação que identifique o aplicativo e o desenvolvedor dentro do sistema. Além disso, o usuário que utiliza o aplicativo deve ser também identificado no sistema para que a cobrança do tráfego gerado se realize corretamente. Um usuário deve proporcionar um token de acesso ao aplicativo e este token deve vir no cabeçalho. O token faz parte da informação pessoal de cada usuário e habilita o acesso do usuário a um aplicativo. Nos ambientes de Testing e Comercial, não adianta fornecer qualquer valor para o token, pois se realiza uma comprovação entre o token, o requestor_id do cabeçalho e o serviceid. Cabeçalho HTTP para envio de requisições às APIs Authorization: SDPBasicAuth realm="sdpapis", consumer_key= "serviceid@spid", signature_method="md5", signature="md5(spid+sppassword+timestamp)", timestamp="yyyymmddhhmmss", version="0.1", token="accesstoken", requestor_id="msisdn", requestor_type="1" spid: Identificador do desenvolvedor na Plataforma de Desenvolvedores Vivo. Um desenvolvedor é identificado por um único spid na Plataforma de Desenvolvedores Vivo, que é mostrado após o registro do usuário na página de informação pessoal do usuário. sppassword: Senha do desenvolvedor na Plataforma de Desenvolvedores Vivo. serviceid: Identificador do aplicativo que realiza as requisições às APIs da Plataforma de Desenvolvedores Vivo. Para começar a desenvolver e acessar às APIs, o desenvolvedor deve possuir o serviceid que lhe dá acesso ao ambiente sandbox. Esta informação é criada após terminar o cadastro e aparece na página de informações pessoais do desenvolvedor. AccessToken: Identificador do usuário que realiza as requisições na Plataforma de Desenvolvedores Vivo. Esta informação é apresentada na página de informações pessoais do usuário. A aplicação deve solicitar este token de acesso ao usuário para que as requisições contenham esta informação. Página 11

12 Figura 6. Página de Informação do Desenvolvedor Página 12