Primeiramente, faça a Autenticação
A autenticação é a chave que fará com que você possa trabalhar com nossa API. Veja em nossos tutoriais como realizar a autenticação.


Primeiros Passos

A plataforma Zeduk permite trabalhar com recursos privados da API através de chamadas HTTP com os verbos GET, PUT, POST, DELETE e todas respostas são em formato JSON. Os recursos privados e as ações próprias dos usuários, como adicionar e remover contatos, enviar notificações para um ou vários contatos e também para grupos.

Por isso, no seguinte guia explicaremos o significado de autenticação e o fluxo de autorização que deve ser aplicado para ter um token (senha de acesso a recursos privados).

Autenticação

URL: http://adm.zeduk.com.br/api/authenticate
Method: POST
Parâmetros esperados: api_key e encryption_key (Ambos podem ser encontrados no site https://adm.zeduk.com)

Exemplo feito com jQuery:

var TOKEN;
var url = "http://adm.zeduk.com.br/api/authenticate";
var params = {
    "api_key": "sua api_key",
    "encryption_key": "sua encryption_key"
};

$.post(url, params, function(result){
    TOKEN = result.token;
});

Client Side

O fluxo de autorização Client side é o adequado para os aplicativos que executam código do lado do cliente, por exemplo, aplicativos desenvolvidos em linguagem javascript/ajax, Angular ou aplicativos mobile.


Server-side

O fluxo de autorização Server side é o mais adequado para os aplicativos que executam código do lado do servidor, por exemplo, aplicativos desenvolvidos em linguagem Java, PHP, Grails, Go, etc.

Explore nossos Recursos
Se você já está trabalhando com nossa API, conheça todos os recursos que estão a seu alcance.


Consultas e Postagens

Os seguintes exemplos servirão para trabalhar com recursos da API Zeduk.
URL API: http://adm.zeduk.com

Recurso Descrição Exemplo
/api/contacts Lista e adiciona contatos GET
POST
/api/contacts/{phone} Exibe, atualiza e deleta um contato GET
PUT
DELETE
/api/menus Lista todos menus criados no painel GET
/api/groups Lista todos grupos criado no painel GET
/api/notify Envia notificações para um ou mais contatos ou grupos, abaixo tabela de parâmetros para este recurso POST
Parâmetro Descrição
msg String com conteudo de texto.
Exemplo: "Não haverá aulas amanhã."
Obrigatório caso não informe imagem ou pdf
phone String ou número com 11 caracteres contendo DDD + número de celular.
Exemplo: 99999999999
Obrigatório caso não informe phones, groupid, groups ou forall
phones Array de telefones.
Exemplo: ["99999999999", "88888888888", "77777777777"]
Obrigatório caso não informe phone, groupid, groups ou forall
img String com url da imagem.
Exemplo: "http://meusite.com/minhaimagem.jpg"
Obrigatório caso não informe mensagem ou pdf
pdf String com url do pdf.
Exemplo: "http://meusite.com/meupdf.pdf"
Obrigatório caso não informe mensagem ou img
pdfname String com o nome do pdf (aparecerá no adm e app).
Exemplo: "boletim"
Obrigatório caso informe pdf
menuid Id de menu criado no painel que pode ser visto em /api/menus.
Exemplo: "2"
Opcional, por padrão "1"
confdelivery Boolean, use se a notificão precisar de confirmação de entrega.
Exemplo: true ou false
Opcional, false por padrão
groupid String com _id de um grupo que pode ser visto em /api/groups.
Exemplo: "520b21ee651ebb443a531375"
Obrigatório caso não informe phone, phones, groups ou forall
groups Array de _id de grupos.
Exemplo: ["320b21ee651ebb443ac3137i", "55yb21ee651ebb443a53we5", "o10b21ee651ebb443a531k72"]
Obrigatório caso não informe phone, phones, groupid ou forall
forall Boolean, indica que o envio será feito para todos contatos.
Exemplo: true ou false
Opcional, false por padrão