manual direct100 api v2 · 3 formatos formatos suportados ... indica o periodo de validade do token...
Post on 21-Jan-2019
230 Views
Preview:
TRANSCRIPT
2
Direct100 API V2
A Direct100 API V2 permite desenvolver e testar aplicações de forma fácil utilizando qualquer linguagem de programação. Pode utilizar a API para enviar vários tipos de mensagens e consultar dados da sua conta Direct100, tais como relatórios de entrega e saldo disponível.
Tabela de Contéudos
•
Formatos: Informação acerca das formatações suportadas.
•
Autenticação: Descrição do processo de autenticação.
-
Token permanente: Como obter um token permanente.
-
Token temporário: Como obter um token temporário.
-
Request: Exemplo de pedido de token temporário.
-
Response: Exemplo de resposta de token temporário.
•
Sms: Informação acerca do envio dos vários tipos de sms.
-
Resquest: Exemplo de pedido.
-
Response: Exemplo de resposta.
•
Relatórios: Consulta de relatórios de entrega.
-
Resquest: Exemplo de pedido.
-
Response: Exemplo de resposta.
•
Recepções: Consulta de mensagens recebidas.
-
Resquest: Exemplo de pedido.
-
Response: Exemplo de resposta.
•
Saldo: Consulta de saldo disponível.
-
Request: Exemplo de pedido de consulta de saldo.
-
Response: Exemplo de resposta de consulta de saldo.
•
Canais Push: Consulta de canais de push notifications.
-
Request: Exemplo de pedido de consulta de canais push.
-
Response: Exemplo de resposta de consulta de canais push.
•
Anexo: Consulta de códigos de erro.
3
Formatos
Formatos suportados
A Direct100 API V2 suporta vários tipos de formatos diferentes tanto nos pedidos como nas respostas. Poderá utilizar o formato de sua preferência dentro dos seguintes: - JSON (application/json) - XML (application/xml e text/xml) - Html (text/html) O formato deverá ser definido no header do pedido (Headers: "Content-Type"). Se não expecificar o formato desejado na resposta (Headers: "Accept"), a resposta será no mesmo formato do pedido.
Autenticação
Autenticação
Por questões de segurança, o acesso à Direct100 API V2 só é possível através de uma ligação segura. O endereço base é o seguinte: https://sistema.direct100.mobi/API/{token}/V2 Para se autenticar junta da Direct100 API V2 deverá fornecer um token válido. Existem 2 tipos de tokens: permanentes e temporários.
Token permanente
Os tokens permanentes podem ser solicitados através do email geral@direct100.mobi. Estes tokens só expiram se nos for especificamente solicitado. Por questões de segurança, estes tokens estão limitados a 100 requests/hora.
Token temporário
Os tokens temporários são tokens apenas válidos durante um espaço de tempo definido. Contrariamente aos tokens permanentes, não tem qualquer limitação no número de requests/hora. Para obter um token temporário deverá enviar um pedido (HTTP POST)
4
com os parametros indicados para o seguinte url: POST https://sistema.direct100.mobi/API/V2/Auth
Parâmetros Username obrigatório
O email com que faz login na sua aplicação Direct100.
Password obrigatório
A password com que faz login na sua aplicação Direct100.
Expires opcional
Indica o periodo de validade do token a criar em minutos. O valor por defeito é de 1 minuto. Para valores superiores a 720 minutos, os pedidos ficam limitados a 100 requests/hora tal como os tokens permanentes.
Exemplo de Pedido
POST https://sistema.direct100.mobi/API/V2/Auth POST Data (application/x-www-form-urlencoded): username=xxx@yyy.com&password=xyz&expires=10 POST Data (application/json): {"Username":"xxx@yyy.com","Password":"xyz","Expires":"10"} POST Data (application/xml): <Auth> <Username>xxx@yyy.com</Username> <Password>xyz</Password> <Expires>1</Expires> </Auth>
Exemplo de Resposta
HTTP/1.1 200 OK Content-Type: application/json; {"Token":"W61LJ47QP92IY83CB56KZ54NR83TM72D","Expires":"1"} HTTP/1.1 200 OK Content-Type: application/xml; <AuthResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Token>W61LJ47QP92IY83CB56KZ54NR83TM72D</Token>
5
<Expires>9</Expires> </AuthResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR05","Description":"Invalid Credentials"} HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR05</Error> <Description>Invalid Credentials</Description> </ErrorResponse> Poderá consultar o significado dos diferentes tipos de erros no anexo.
Sms
Envio de Sms
Para o envio de sms deverá enviar um pedido (HTTP POST) com os parametros indicados para o seguinte url: POST https://sistema.direct100.mobi/API/{token}/V2/Sms
Parâmetros
6
Username obrigatório
O email com que faz login na sua aplicação Direct100.
Message obrigatório
A mensagem a enviar. Limitada a 160 caracteres.
Telephones obrigatório
Listagem de números para os quais enviar a mensagem.
DateToSend opcional
Data no formato "dd-mm-aaaa hh:mm". Se for expecificado, a mensagem será calendariada para a data indicada, caso contrário será enviada imediatamente.
Sender opcional
Remetente da mensagem. Deverá ser um remetente associado a conta Direct100. O remetente por defeito é "1040".
Type opcional
Tipo de sms a enviar. As opções são as seguintes: SMS Long_SMS Flash_SMS Unicode_SMS Wap_Push Low_Cost A opção por defeito é "SMS".
Wap opcional
No caso de ter escolhido o tipo "Wap_Push", pode especificar neste parâmetro o url desejado.
Exemplo de Pedido
POST https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Sms POST Data (application/x-www-form-urlencoded): username=xxx@yyy.com&Message=Teste Direct100 API V2&Telephones=351910000000&Telephones=351960000000&DateToSend=01-01-2020 08:00&Sender=Direct100&Type=Wap_Push&Wap=www.direct100.mobi POST Data (application/json): {"Username":"xxx@yyy.com","Message":"Teste Direct100 API V2","Telephones":["351910000000","351960000000"],"DateToSend":"01-01-2020 08:00","Sender":"Direct100","Type":"Wap_Push","Wap":"www.direct100.mobi"} POST Data (application/xml): <Sms> <Username>xxx@yyy.com</Username> <Message>Teste Direct100 API V2</Message> <Telephones>
7
<Tel>351910000000</Tel> <Tel>351910000000</Tel> </Telephones> <DateToSend>01-01-2020 08:00</DateToSend> <Sender>Direct100</Sender> <Type>Wap_Push</Type> <Wap>www.direct100.mobi</Wap> </Sms>
Exemplo de Resposta
HTTP/1.1 200 OK Content-Type: application/json; {"Id":"FrZzOZ8Dalg=","Balance":"1,75 euros"} HTTP/1.1 200 OK Content-Type: application/xml; <SmsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Id>FrZzOZ8Dalg=</Id> <Balance>1,75 euros</Balance> </SmsResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR03","Description":"Invalid Token"} HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR03</Error> <Description>Invalid Token</Description> </ErrorResponse> Poderá consultar o significado dos diferentes tipos de erros no anexo.
8
Relatório
Consultar relatórios de entrega
Para consultar relatórios de entrega deverá enviar um pedido (HTTP GET) com os parametros indicados para o seguinte url: GET https://sistema.direct100.mobi/API/{token}/V2/Report Se não expecificar nenhum parâmetro, será devolvido o último relatório disponível.
Parâmetros Id opcional
O Id do envio cujos relatórios de entrega deseja consultar.
Telephones opcional
Listagem dos números cujo relatório de entrega deseja consultar.
Start opcional
Data no formato "dd-mm-aaaa hh:mm". Data a partir da qual deseja obter relatórios de entrega.
End opcional
Data no formato "dd-mm-aaaa hh:mm". Data até à qual deseja obter relatórios de entrega.
Offset opcional
Número de relatórios a partir do qual seja receber.
Count opcional
Número de relatórios que deseja receber.
9
Exemplo de Pedido
GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Report GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Report?id=FrZzOZ8Dalg=&telephones=351910000000&telephones=351960000000&start=07-02-2013%2010:00&end=07-02-2013%2018:00&count=5&offset=10
Exemplo de Resposta
HTTP/1.1 200 OK Content-Type: application/json; {"Reports":[{"Id":"FrZzOZ8Dalg=","Telephone":"351910000000","SentDate":"04-10-2013 10:00","ReportDate":"04-10-2013 10:01","Status":"Delivered"},{"Id":"FrZzOZ8Dalg=","Telephone":"351960000000","SentDate":"04-10-2013 10:00","ReportDate":"04-10-2013 10:03","Status":"Delivered"}]} HTTP/1.1 200 OK Content-Type: application/xml; <ReportResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Report> <Id>FrZzOZ8Dalg=</Id> <Telephone>351910000000</Telephone> <SentDate>04-10-2013 10:00</Sentdate> <ReportDate>04-10-2013 10:01</ReportDate> <Status>Delivered</Status> </Report> <Report> <Id>FrZzOZ8Dalg=</Id> <Telephone>351960000000</Telephone> <SentDate>04-10-2013 10:00</Sentdate> <ReportDate>04-10-2013 10:03</ReportDate> <Status>Delivered</Status> </Report> </ReportResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR03","Description":"Invalid Token"}
10
HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR03</Error> <Description>Invalid Token</Description> </ErrorResponse> Poderá consultar o significado dos diferentes tipos de erros no anexo.
Recepções
Consultar mensagens recebidas
Para consultar as mensagens recebidas deverá enviar um pedido (HTTP GET) com os parametros indicados para o seguinte url: GET https://sistema.direct100.mobi/API/{token}/V2/Reply Se não expecificar nenhum parâmetro, será devolvida última mensagem recebida.
Parâmetros Start opcional
Data no formato "dd-mm-aaaa hh:mm". Data a partir da qual deseja obter as mensagens recebidas.
End opcional
Data no formato "dd-mm-aaaa hh:mm". Data até à qual deseja obter as mensagens recebidas.
Offset opcional
Número de mensagens a partir do qual seja receber.
Count opcional
Número de mensagens que deseja receber.
Exemplo de Pedido
GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Reply GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Reply?start=07-02-2013%2010:00&end=07-02-2013%2018:00&count=5&offset=10
Exemplo de Resposta
11
HTTP/1.1 200 OK Content-Type: application/json; {"Replies":[{"ShortNumber":"4010","Keyword":"Direct100","Telephone":"351910000000","Date":"06-02-2013 16:46:29","Message":"Direct100 Teste 1"},{"ShortNumber":"4010","Keyword":"Direct100","Telephone":"351960000000","Date":"06-02-2013 16:43:08","Message":"Direct100 Teste 2"}]} HTTP/1.1 200 OK Content-Type: application/xml; <ReplyResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Reply> <ShortNumber>4010</ShortNumber> <Keyword>Direct100</Keyword> <Telephone>351910000000</Telephone> <Date>06-02-2013 16:46:29</Date> <Message>Direct100 Teste 1</Message> </Reply> <Reply> <ShortNumber>4010</ShortNumber> <Keyword>Direct100</Keyword> <Telephone>351960000000</Telephone> <Date>06-02-2013 16:43:08</Date> <Message>Direct100 Teste 2</Message> </Reply> </ReplyResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR03","Description":"Invalid Token"} HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR03</Error> <Description>Invalid Token</Description> </ErrorResponse> Poderá consultar o significado dos diferentes tipos de erros no anexo
12
Saldo
Consulta de Saldo
Para consultar o saldo disponível na sua aplicação Direct100 deverá enviar um pedido (HTTP GET) para o seguinte url: GET https://sistema.direct100.mobi/API/{token}/V2/Balance
Exemplo de Pedido
GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/Balance
Exemplo de Resposta
HTTP/1.1 200 OK Content-Type: application/json; {"Balance":"1,04 euros"} HTTP/1.1 200 OK Content-Type: application/xml; <BalanceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Balance>1,04 euros</Balance> </BalanceResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR03","Description":"Invalid Token"} HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR03</Error> <Description>Invalid Token</Description> </ErrorResponse>
13
Canais Push
Consultar canais push
Para consultar os canais push associados a uma app, deverá enviar um pedido (HTTP GET) para o seguinte url: GET https://sistema.direct100.mobi/API/{token}/V2/PushChannels/{AppId}
Parâmetros Id opcional
Id do canal que deseja visualizar.
Exemplo de Pedido
GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/PushChannels/abcdefghij GET https://sistema.direct100.mobi/API/W61LJ47QP92IY83CB56KZ54NR83TM72D/V2/PushChannels/abcdefghij?Id=2
Exemplo de Resposta
HTTP/1.1 200 OK Content-Type: application/json; {"Channels":[{"Id":"1","Name":"News","Image":" https://sistema.direct100.mobi/Content/Files/Push/news.jpg"},{"Id":"2","Name":"Promotions","Image":" https://sistema.direct100.mobi/Content/Files/Push/prom.jpg"}]} HTTP/1.1 200 OK Content-Type: application/xml; <PushChannelsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Channel> <Id>1</Id> <Name>News</Name> <Image> https://sistema.direct100.mobi/Content/Files/Push/news.jpg</Image> </Channel> <Channel> <Id>2</Id> <Name>Promotions</Name> <Image> https://sistema.direct100.mobi/Content/Files/Push/prom.jpg</Image>
14
</Channel> </PushChannelsResponse> No caso de ocorrer algum erro, a resposta apresentará o seguinte formato: HTTP/1.1 200 OK Content-Type: application/json; {"Error":"ERROR03","Description":"Invalid Token"} HTTP/1.1 200 OK Content-Type: application/xml; <ErrorResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Error>ERROR03</Error> <Description>Invalid Token</Description> </ErrorResponse> Poderá consultar o significado dos diferentes tipos de erros no anexo.
Anexo
Códigos de erro
ERROR00 Internal Server Error ERROR01 No Valid Contact ERROR02 Not enough credit ERROR03 Invalid Token
top related