Zenvia Developers

Developers Blog

API Monetize

Versão: 1.0.0
URL: zcast-api.zynk.to/

A API de integração foi desenvolvida utilizando recursos como HTTP, REST e JSON. Todas as chamadas enviam e recebem objetos JSON relativos às entidades que serão manipuladas. Confira a documentação para saber quais parâmetros passar em cada chamada:

❕- ! Passagem do parâmetro é obrigatória
❔- ? Parâmetro é opcional

Para cada método da API, está disponível um exemplo utilizando cUrl.

Autenticação

O método a seguir demostra a forma de autenticação.

Descrição
Método de autenticação HTTP Basic.

Coleções

Criar as coleções que serão vistas pelas pessoas.
As coleções podem ser consideradas aulas, dicas ou seja, um agrupados global que irá receber pequenos conteúdos específicos.

URL Descrição
POST https://zcast-api.zynk.to/collections Cria uma coleção específica.
PUT https://zcast-api.zynk.to/collections/external_id Atualiza uma coleção especificada.
DELETE https://zcast-api.zynk.to/collections/external_id Apaga uma coleção de uma organização.
GET https://zcast-api.zynk.to/collections Retorna uma lista com todas as coleções de uma organização.
GET https://zcast-api.zynk.to/collections/external_id Retorna as informações detalhadas de uma coleção.
POST https://zcast-api.zynk.to/collections/external_id/associations Relaciona uma coleção com seus conteúdos
DELETE https://zcast-api.zynk.to/collections/external_id/associations Remover a relação da coleção com seus conteúdos

Conteúdos

Criar os conteúdos que serão vistos pelas pessoas.
Os conteúdo são agrupados dentro de coleções e assim serão vistos conforme uma ordem interna na coleção. A distribuição do conteúdo depende do meio (tipo) do conteúdo. Exemplo: SMS, Wap ou Web.

URL Descrição
POST https://zcast-api.zynk.to/contents Cria um conteúdo.
PUT https://zcast-api.zynk.to/contents/external_id Atualiza um conteúdo especificado.
DELETE https://zcast-api.zynk.to/contents/external_id Apaga um conteúdo.
GET https://zcast-api.zynk.to/contents Retorna uma lista com todos os conteúdo de uma organização.
GET https://zcast-api.zynk.to/contents/external_id Retorna as informações detalhadas de um conteúdo.

Pessoas

Manipulam os usuários que irão acessar o Monetize.

URL Descrição
POST https://zcast-api.zynk.to/recipients Cria uma pessoa específica.
PUT https://zcast-api.zynk.to/recipients/external_id Atualiza uma pessoa especificada.
DELETE https://zcast-api.zynk.to/recipients/external_id Apaga uma pessoa de uma organização.
GET https://zcast-api.zynk.to/recipients Retorna uma lista com todas as pessoas de uma organização.
GET http://zcast-api.zynk.to/recipients/external_id Retorna as informações detalhadas de uma pessoa.
POST https://zcast-api.zynk.to/recipients/external_id/associations Faz a associação de um pessoa a um ou mais grupos.
DELETE https://zcast-api.zynk.to/recipients/external_id/associations Desfaz associação de um pessoa a um ou mais grupos.
GET https://zcast-api.zynk.to/recipients/external_id/content Obtém o próximo conteúdo para a pessoa informada.
GET https://zcast-api.zynk.to/recipients/external_id/collection Obtém a coleção atual da pessoa informada.
GET https://zcast-api.zynk.to/recipients/external_id/checkstatus Obtém o status da pessoa informada. Caso a pessoa esteja ativa, retorna ainda a coleção atual.

Paginação

Todos os métodos GET trazem listas paginadas. Por padrão, apenas os 10 primeiros registros são retornados. Para trazer mais registros, passe na URL os seguintes parâmetros:

– offset: posição do registro que deseja iniciar a listagem (1 = primeiro registro)
limit: quantidade de registros a serem retornados a partir da posição indicada por offset (default =10)

Exemplo:

  • Lista com os 100 primeiros canais: https://zcast-api.zynk.to/channels?offset=1&limit=100
Anúncios

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair /  Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair /  Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair /  Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair /  Alterar )

w

Conectando a %s