EntrarMenu
API

APIbeta

A e-nautia oferece-lhe uma REST API pública. O URL de base para todas as chamadas é: https://api.e-nautia.com
Encontrando-se atualmente na versão beta, a API provavelmente evoluirá a qualquer momento. Subscreva a nossa newsletter para permanecer informado.

Os acessos são efetuados através do método POST HTTP, utilizando o parâmetro "token" obtido após a primeira autenticação. Todas as chamadas API retornam um código http 200 sem consistências, através de um objeto JSON. Os carateres são codificados utilizando UTF-8.

Quando os dados são modificados, eles são datados usando o formato UTC YYYY-MM-DD HH:mm:ss através uma variável de "modification".

A remoção de dados é efetuada em duas fases. Uma variável associada "del" está situada em 1 quando a linha foi eliminada e em 0 quando a linha ainda existir. Por conseguinte, para eliminar uma linha, esta deve ser editada ao introduzir a variável "del" em 1. O servidor e-nautia efetuará a eliminação completa após um mês.

Autenticação

Identificação

URI: /login

Dados a serem enviados:

Nome Tipo Descrição
login cadeia Identificador ou o endereço de e-mail do utilizador
password cadeia Password do utilizador
lang cadeia Idioma a ser utilizado. Valores possíveis:
de: Alemão
en: Inglês
es: Espanhol
fr: Francês
it: Italiano
pt: Português

Resposta, caso a autenticação falhe:

{
"access_token":"ZkcqmSWsKnMSXq5hPpWd",
"expires_in":3600,
"token_type":"Bearer"
}
Variável Descrição
access_token Valor a ser mantido e a ser reutilizado pela aplicação
expires_in Duração em segundos, durante a qual a utilização da API com o acess_token é permitida
Posteriormente, uma nova autenticação deverá ser feita.
token_type Método para gerar o acess_token

Resposta, caso a autenticação falhe:

{
"errorCode":2,
"errorMessage":"A password está incorreta."
}
Variável Descrição
errorCode Erro de código
errorMessage Mensagem de erro

Resposta, no caso de uma utilização inválida de um acess_token:

{
"statusCode":401,
"statusMessage":"invalid token"
}

Uma nova autenticação terá então de ser efetuada.

Nomes dos e-mails de servidor e FTP

URI: /server

Exemplo de uma resposta:

{
"login":"georges",
"name":"Georges O Yeti",
"ftpserver":"e2.e-nautia.com",
"imapserver":"mail.e-nautia.com",
"popserver":"mail.e-nautia.com",
"smtpserver":"mail.e-nautia.com",
"mail":"contact@e-nautia.com"
}
Variável Descrição
login Identificador
name Nome completo
ftpserver Nome do servidor FTP (retornado apenas se o acesso for autorizado)
imapserver Nome do servidor IMAP (retornado apenas se o acesso for autorizado)
popserver Nome do servidor POP (retornado apenas se o acesso for autorizado)
smtpserver Nome do servidor SMTP (retornado apenas se o acesso for autorizado)
mail Endereço de e-mail (retornado apenas se o acesso for autorizado)

Contatos

Recuperar Contatos

URI: /contacts

Exemplo de uma resposta:

[
{"id":111,
"g":{"value":770,"modification":"2015-01-01 00:00:00"},
"email":{"value":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
"fullname":{"value":"Georges O Yeti","modification":"2015-01-01 00:00:00"},
"firstname":{"value":"Georges","modification":"2015-01-01 00:00:00"},
"lastname":{"value":"O Yeti","modification":"2015-01-01 00:00:00"},
"homecity":{"value":"Strasbourg","modification":"2015-01-01 00:00:00"}
},
{"id":112,
"g":{"value":770,"modification":"2015-01-01 00:00:00"},
"email":{"value":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
"fullname":{"value":"Big Foot","modification":"2015-01-01 00:00:00"},
"firstname":{"value":"Big","modification":"2015-01-01 00:00:00"},
"lastname":{"value":"Foot","modification":"2015-01-01 00:00:00"},
"homecity":{"value":"Le Havre","modification":"2015-01-01 00:00:00"}
}
]

Todas as variáveis que possam um dado que tenha sido gravado foram retornadas.

Dados genéricos:

Variável Descrição
id Identificador único do contato
value Valor gravado
modification Data da última modificação dos dados associados

Dados editáveis:

Nome Tipo Descrição
g inteiro Identificador do grupo de contatos
mail cadeia Endereço de e-mail
firstname cadeia Primeiro nome
lastname cadeia Apelido
organization cadeia Nome da organização
fullname cadeia Nome completo
mobilephone cadeia Número de telemóvel
homestreet cadeia Endereço da residência pessoal
homecity cadeia Cidade da residência pessoal
homepostalcode cadeia Código postal da residência pessoal
homefax cadeia Número de fax da residência pessoal
homephone cadeia Número de telefone fixo da residência pessoal
birthday date Data de nascimento
notes cadeia Nota
webpage cadeia Página web
del inteiro 0, se deseja restaurar o contato
1, se deseja eliminar o contato

Adicionar um contato

URI: /contacts/add

Exemplo de uma resposta:

{
"id":111,
{"g":770,"gname":"Amigos","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges O Yeti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"O Yeti","modification":"2015-01-01 00:00:00"},
{"homecity":"Strasbourg","modification":"2015-01-01 00:00:00"}
}

Dados gravados como contato foram retornados, tendo cada um a data da sua última modificação.

Modifique um contato

URI: /contacts/edit/{id}
({id} para substituir pelo valor apropriado)

Exemplo de uma resposta:

{
"id":111,
{"g":770,"gname":"Amigos","modification":"2015-01-01 00:00:00"},
{"email":"contact@e-nautia.com","modification":"2015-01-01 00:00:00"},
{"fullname":"Georges O Yeti","modification":"2015-01-01 00:00:00"},
{"firstname":"Georges","modification":"2015-01-01 00:00:00"},
{"lastname":"O Yeti","modification":"2015-01-01 00:00:00"},
{"homecity":"Strasbourg","modification":"2015-01-01 00:00:00"}
{"del":1,"modification":"2015-01-01 00:00:00"}
}

Dados gravados como contato foram retornados, tendo cada um a data da sua última modificação.

Categorias de contatos

Recuperar as categorias de contatos

URI: /contacts/groups

Exemplo de uma resposta:

[
{"id":770,
"name":{"value":"Amigos","modification":"2015-01-01 00:00:00"},
}
{"id":771,
"name":{"value":"Tarefa","modification":"2015-01-01 00:00:00"}
}
]

Todas as variáveis que possam um dado que tenha sido gravado foram retornadas.

Dados genéricos:

Variável Descrição
id Identificador único do contato
value Valor gravado
modification Data da última modificação dos dados associados

Dados editáveis:

Nome Tipo Descrição
name cadeia Nome da categoria
del inteiro 0, se deseja restaurar a categoria
1, se deseja eliminar a categoria

Adicionar uma categoria de contatos

URI: /contacts/groups/add

Exemplo de uma resposta:

{
"id":770,
{"name":"Amigos","modification":"2015-01-01 00:00:00"}
}

Os dados gravados como categoria foram retornados, tendo cada um a data da sua última modificação.

Modifique uma categoria de contatos

URI: /contacts/groups/edit/{id}
({id} para substituir pelo valor apropriado)

Exemplo de uma resposta:

{
"id":770,
{"name":"Amigos","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Os dados gravados como categoria foram retornados, tendo cada um a data da sua última modificação.

Notas

Recuperar notas

URI: /notes

Exemplo de uma resposta:

[
{"id":11,
"title":{"value":"Tarefas a executar","modification":"2015-01-01 00:00:00"},
"note":{"value":"Limpar","modification":"2015-01-01 00:00:00"},
"del":{"value":0,"modification":"2015-01-01 00:00:00"}
},
{"id":12,
"title":{"value":"Ir às compras","modification":"2015-01-01 00:00:00"},
"note":{"value":"Batatas e muito mais","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
}
]

Todas as variáveis que possam um dado que tenha sido gravado foram retornadas.

Dados genéricos:

Variável Descrição
id Identificador único de nota
value Valor gravado
modification Data da última modificação dos dados associados

Dados editáveis:

Nome Tipo Descrição
title cadeia Título
note texto Conteúdo da nota
del inteiro 0, se deseja restaurar a nota
1, se deseja eliminar a nota

Adicionar uma nota

URI: /notes/add

Exemplo de uma resposta:

{
"id":11,
{"title":"Tarefas a executar","modification":"2015-01-01 00:00:00"},
{"note":"Limpar","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Dados gravados como nota foram retornados, tendo cada um a data da sua última modificação.

Modificar uma nota

URI: /notes/edit/{id}
({id} para substituir pelo valor apropriado)

Exemplo de uma resposta:

{
"id":11,
{"title":"Tarefas a executar","modification":"2015-01-01 00:00:00"},
{"note":"Limpar","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Dados gravados como nota foram retornados, tendo cada um a data da sua última modificação.

Calendário

Recuperar encontros

URI: /calendar

Exemplo de uma resposta:

[
{"id":99,
"title":{"value":"Uma tarde com amigos","modification":"2015-01-01 00:00:00"},
"start":{"value":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
"end":{"value":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
"place":{"value":"Na Bibi","modification":"2015-01-01 00:00:00"},
"del":{"value":1,"modification":"2015-01-01 00:00:00"}
},
{"id":105,
"title":{"value":"Aulas","modification":"2015-01-01 00:00:00"},
"start":{"value":"2016-09-01 09:00:00","modification":"2015-01-01 00:00:00"},
"end":{"value":"2016-06-30 17:30:00","modification":"2015-01-01 00:00:00"},
"re":{"value":"|N1|N2|N3|N4|N5|","modification":"2015-01-01 00:00:00"}
}
]

Todas as variáveis que possam um dado que tenha sido gravado foram retornadas.

Dados genéricos:

Variável Descrição
id Identificador único de encontro
value Valor gravado
modification Data da última modificação dos dados associados

Dados editáveis:

Nome Tipo Descrição
title cadeia Título
start data e hora Data de início
end data e hora Data de fim
description Notas Descrição
place texto Endereço
re cadeia Recuperar encontros
Se houver repetições a serem aplicadas, estas são separadas pelo carater | e são apresentadas segundo o apresentado nos exemplos seguintes.
Um dia da semana: N seguido pelo número do dia (de 1 para segunda-feira até 7 para domingo)
Um dia do mês: d seguido pelo número do dia (de 01 até 31)
Mês: m seguido pelo número do mês (de 01 até 12)
Exemplo: |N1|N2|m12| para uma repetição a ser aplicada em todas as segundas e terças-feiras de Dezembro
del inteiro 0, se deseja restaurar o encontro eliminado
1, se deseja eliminar o encontro

Adicionar um encontro

URI: /calendar/add

Exemplo de uma resposta:

{
"id":99,
{"title":"Uma tarde com amigos","modification":"2015-01-01 00:00:00"},
{"start":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
{"end":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
{"place":"Na Bibi","modification":"2015-01-01 00:00:00"}
}

Os dados gravados como encontro foram retornados, tendo cada um a data da sua última modificação.

Modifique um encontro

URI: /calendar/edit/{id}
({id} para substituir pelo valor apropriado)

Exemplo de uma resposta:

{
"id":99,
{"title":"Uma tarde com amigos","modification":"2015-01-01 00:00:00"},
{"start":"2016-01-01 20:00:00","modification":"2015-01-01 00:00:00"},
{"end":"2016-01-01 22:30:00","modification":"2015-01-01 00:00:00"},
{"place":"Na Bibi","modification":"2015-01-01 00:00:00"},
{"del":0,"modification":"2015-01-01 00:00:00"}
}

Os dados gravados como encontro foram retornados, tendo cada um a data da sua última modificação.

SMS

Enviar uma SMS

URI: /send/send

Dados editáveis:

Nome Tipo Descrição
number cadeia Número do destinatário em formato internacional (+CCXXXXXXXXX onde CC é o código do país e XXXXXXXXX é o número local)
message texto Mensagem com um máximo de 160 carateres

Exemplo de uma resposta:

{
"code":1,
"message":"SMS enviada"
}

Dados genéricos:

Variável Descrição
code Código de retorno - Valores possíveis:
1: SMS enviada
2: número incorreto
3: crédito insuficiente. Por favor recarregue a sua conta.
4: quota preenchida. Por favor tente novamente mais tarde.
5: erro interno. Por favor contate o apoio.
message Descrição do código de retorno
DeutschEnglishEspañolFrançaisItalianoPortuguês
© e-nautia[PT] ▲ Termos de uso Newsletter Contato Ajuda