Plataforma Playhub- APIs para Interface

Externa
I. Introdução
A plataforma Playhub disponibiliza um conjunto de APIs contendo WebServices através dos
quais é possível criar e atualizar clientes e assinaturas de uma determinada ISP. Através dela é
possível criar interfaces automáticas entre sistemas externos e a plataforma Playhub.

II. Versões
Existem 2 versões das APIs Playhub disponibilizadas na Web:

• Versão v1
Possui funcionalidades para criação, atualização e consulta de dados e assinaturas de um
cliente.
A documentação para desenvolvimento encontra-se em:
http://stage3.pca.com.br/playhub/api/docs/v1.0/

• Versão v3

Possui funcionalidades da versão v1, porém com acréscimo dos campos "Email" e "Mobile" nas
informações do cliente
http://stage3.pca.com.br/playhub/api/docs/v3.0/

III. Credenciais
Cada ISP recebe um conjunto único de credenciais que identifica e autoriza a ISP durante a
utilização das APIs. Esse conjunto de credenciais para produção é entregue após a interface do
sistema externo ter sido desenvolvida e homologada junto a Playhub.

IV. Descrição de objetos

A plataforma Playhub apresenta dois tipos de objetos que podem ser acessadas através das
APIs

Cliente: Contém os dados de um cliente que pode acessar serviços on-line. Esses dados são:

• Username: Campo obrigatório, é a chave primária de identificação do cliente. Deve ser

maior que 8 caracteres, pode conter letras, números, underline ("_"), ponto final (".")
e arroba ("@"). Não pode ser alterado depois do cliente ter sido criado. Dentro de uma
mesma ISP, não pode haver dois registros de clientes com o mesmo login. Esse é o
login que será usado (prefixado com o código de 3 letras da ISP na Playhub) como login
identificador quando o cliente logar em um dos aplicativos de disponibilização de
conteúdo
• Password: Campo obrigatório, contendo letras e número. Será a senha que o cliente
irá utilizar para se autenticar (junto com o login) ao identificar nos aplicativos de
disponibilização de conteúdo.
 • Document: Campo opcional, pode ser deixado em branco (""). Se for preenchido,
precisa ser um CPF ou CNPJ válido. Dentro de uma ISP, dois clientes diferentes não
podem ter o mesmo CPF/CNPJ.
• Name: O Nome do cliente (ou Nome Fantasia, ou Razão Social, o que for de
preferência). Não é obrigatório, podendo ser deixado em branco (""), mas é
recomendado preenchê-lo para facilitar identificações. Dois clientes diferentes podem
ter o mesmo nome
• Email: Disponível apenas na v3. Campo opcional, pode ser deixado em branco ("").
Representa um email associado ao cliente. Apenas usado para registro hoje, mas pode
vir a ser utilizado em expansões futuras do lineup (pode haver novos provedores de
conteúdo que exijam Email para utilizar seus produtos no futuro)
• Mobile: Disponível apenas na v3. Campo opcional, pode ser deixado em branco ("").
Representa um número de telefone celular da região do Brasil associado ao cliente.
Deve ser passado no formato "DD9NNNNNNNN", por exemplo 11993334444 para
representar o telefone +55-11-99333-4444. Para determinados produtos pode ser
obrigatório que o campo celular esteja preenchido (por exemplo, os produtos Deezer
exigem isso, e também exigem que o número de telefone seja único por cliente).

Assinatura: Indica que um cliente tem permissão para acessar um determinado serviço on-line
(SVA). Contém os dados

• Username: Indica o cliente que está permitido a acessar o serviço. É necessário que
um cliente com esse mesmo "Username" já tenha sido anteriormente criado (via API
ou backoffice) para poder ser utilizado com sucesso nas APIs; caso contrário o Web
Service retorna falha
• ProductId: Código alfanumérico que identifica o serviço autorizado para o cliente.
Cada serviço dentro do lineup oferecido pela Playhub tem seu código próprio e a lista
desses códigos é passada para a ISP pela Playhub quando sua área de trabalho em
produção é criada.

V. Token de autenticação
Em qualquer das versões da API existe o método de geração de token

/authentication/tokens

Esse método retorna token a ser usado em todas as chamadas de outros métodos da API no
header Authorization, servindo para conferência de identidade e liberação de funcionalidade.

Cada token tem validade de 30 minutos, depois dos quais deixa de funcionar para liberação
das chamadas aos métodos da API.

VI. Suporte para desenvolvimento

Para as empresas interessadas em desenvolver interfaces entre seus sistemas e a plataforma
Playhub, a Playhub oferece acesso a um ambiente isolado (sandbox) onde os testes durante a
fase de desenvolvimento podem ser realizados de forma segura. Também conta com linha de
suporte técnico para dúvidas ou dificuldades técnicas com a API durante a fase de
desenvolvimento. Para ter acesso a esse suporte, a empresa deve entrar em contato com o
atendimento Playhub para orientação.
Após o desenvolvimento a interface deve passar por um processo de homologação conjunto
envolvendo equipes da empresa desenvolvedora e da Playhub. Tendo sido aprovada nesse
processo, a interface será liberada para uso em produção.