Visão geral
O MyScanner é um portal de suporte ao cliente baseado na nuvem, criado com o objetivo de permitir que os clientes acessem seus dados de digitalização e seus scanners de forma segura, em tempo real, de qualquer lugar e a qualquer hora.
A API do MyScanner faz parte da categoria Representational State Transfer (REST). Ela permite que você execute operações “RESTful”, como ler dados digitalizados do seu scanner com segurança.
Para obter o guia completo da API do MyScanner, faça o download abaixo.
Operação
A API do MyScanner usa JSON simples em HTTP1 e usa os seguintes verbos HTTP:
| Comando | Objetivo |
|---|---|
| OBTER | Obter um ou mais objetos |
Observação:
- Todas as solicitações de API devem atingir o endpoint seguro, ou seja, somente HTTPS
- No momento, a API não permite a criação (POST), modificação (PUT) ou exclusão (DELETE) de dados de varredura
Limite de taxa
Atualmente, o número de chamadas à API por hora é ilimitado. A LoadScan se reserva o direito de alterar isso a qualquer momento sem notificação.
Políticas
As APIs podem ser removidas ou modificadas a qualquer momento sem aviso prévio, mas nos esforçaremos para manter a funcionalidade existente sempre que possível.
Política de mudança de versão
As alterações que não interrompem uma API, como a adição de um novo atributo, podem ser feitas a qualquer momento. As alterações que quebram uma API de nível de produção, como a remoção de atributos ou grandes mudanças no comportamento da API, só serão feitas com um aviso prévio de 60 dias. No entanto, pode haver raras ocasiões em que, por motivos legais, de desempenho ou de segurança, sejamos forçados a fazer alterações que quebrem a API sem aviso prévio.
Autenticação
A autenticação na API do MyScanner é restrita de acordo com a conta do usuário e o scanner, por meio do uso de tokens de API. Os tokens de API estão vinculados à sua conta de usuário do MyScanner e à lista de scanners aos quais você tem acesso.
Os tokens de API são cadeias de 64 bytes (com 64 caracteres) e utilizam o código de autenticação de mensagem com hash chaveado (HMAC), que usa o algoritmo de hash seguro SHA-256, uma função unidirecional que não pode ser descriptografada nem revertida.
A conexão com a API do MyScanner é feita por HTTPS.
Você pode usar seu token de API para autenticar a solicitação; não é preciso digitar senha.
Por exemplo, se o seu token de API for:
5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
E o número de série do seu scanner é:
111111
Então, um exemplo de URL é:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Observação:
- Se você não tiver certeza do número de série do seu scanner LVS, consulte a Documentação do Usuário do LVS
Obtenção de uma chave de API
- Faça login no MyScanner
- Clique no nome da sua conta no canto superior direito.
- Quando o menu suspenso for exibido, clique em “Profile” (Perfil).
- Clique na guia “API Token”.
- Clique em “Generate API Token” (Gerar token de API).
- Quando a caixa de diálogo de confirmação for exibida, clique em “Generate API Token” (Gerar token de API) mais uma vez.
- Seu token de API será gerado.
O que a API oferece
Todas as informações relacionadas ao scanner que você inseriu na sua chamada à API podem ser recuperadas. Isso significa que todos os registros de escaneamento já gravados pelo MyScanner podem ser recuperados.
Direitos de acesso
Sua capacidade de acessar dados depende das permissões disponíveis para o usuário do MyScanner.
Esquema
Campos em branco:
Os campos em branco são incluídos como nulos ou “” em vez de serem omitidos.
Campos DateTime:
Todos os registros de data e hora são retornados no formato ISO 8601 AAAA-MM-DD HH:MM:SS (Exemplo: 2016-12-25 13:30:00)
Solicitações
Todas as solicitações exigem a definição de, no mínimo, dois parâmetros GET.
- O número de série1 do scanner para o qual você deseja recuperar dados
- Seu token da API do MyScanner2
Observação:
- Se você não tiver certeza do número de série do seu scanner LVS, consulte a Documentação do Usuário do LVS
- Consulte a documentação acima com relação à geração do token da API do MyScanner
Obter tudo
| OBTER | todos os registros | |||
|---|---|---|---|---|
| Caso de uso | Você deseja retornar todos os dados de digitalização de um scanner. | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
… …
]
Registro MAIOR DO QUE
| OBTER | todos os registros | > | último registro | |
|---|---|---|---|---|
| Caso de uso | Você deseja retornar todos os dados de digitalização de um scanner após o último número de registro armazenado: 111111-000017 | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
| último registro | string(13 | XXXXXX-XXXXXX | 111111-000017 | |
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&lastrecord=111111-000017&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
]
DateTime AFTER
| OBTER | todos os registros | |||
| DEPOIS | ||||
| Casos de uso | Você deseja obter todos os dados de varredura de todos os registros após a data (25 de agosto de 2015) e a hora (12:48h) | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
| após | string(19) | YYYY-MM-DD+HH:MM:SS | 2015-07-25+00:48:00 | |
Observações:
O símbolo ‘+’ separa DATA+HORA apenas para fins de codificação de URL. A API reconhece espaços em branco, ‘%20’ ou ‘+’
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&after=25/07/2015+00:48:00&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
]
Neste artigo
Visão geral
O MyScanner é um portal de suporte ao cliente baseado na nuvem, criado com o objetivo de permitir que os clientes acessem seus dados de digitalização e seus scanners de forma segura, em tempo real, de qualquer lugar e a qualquer hora.
A API do MyScanner faz parte da categoria Representational State Transfer (REST). Ela permite que você execute operações “RESTful”, como ler dados digitalizados do seu scanner com segurança.
Para obter o guia completo da API do MyScanner, faça o download abaixo.
Operação
A API do MyScanner usa JSON simples em HTTP1 e usa os seguintes verbos HTTP:
| Comando | Objetivo |
|---|---|
| OBTER | Obter um ou mais objetos |
Observação:
- Todas as solicitações de API devem atingir o endpoint seguro, ou seja, somente HTTPS
- No momento, a API não permite a criação (POST), modificação (PUT) ou exclusão (DELETE) de dados de varredura
Limite de taxa
Atualmente, o número de chamadas à API por hora é ilimitado. A LoadScan se reserva o direito de alterar isso a qualquer momento sem notificação.
Políticas
As APIs podem ser removidas ou modificadas a qualquer momento sem aviso prévio, mas nos esforçaremos para manter a funcionalidade existente sempre que possível.
Política de mudança de versão
As alterações que não interrompem uma API, como a adição de um novo atributo, podem ser feitas a qualquer momento. As alterações que quebram uma API de nível de produção, como a remoção de atributos ou grandes mudanças no comportamento da API, só serão feitas com um aviso prévio de 60 dias. No entanto, pode haver raras ocasiões em que, por motivos legais, de desempenho ou de segurança, sejamos forçados a fazer alterações que quebrem a API sem aviso prévio.
Autenticação
A autenticação na API do MyScanner é restrita de acordo com a conta do usuário e o scanner, por meio do uso de tokens de API. Os tokens de API estão vinculados à sua conta de usuário do MyScanner e à lista de scanners aos quais você tem acesso.
Os tokens de API são cadeias de 64 bytes (com 64 caracteres) e utilizam o código de autenticação de mensagem com hash chaveado (HMAC), que usa o algoritmo de hash seguro SHA-256, uma função unidirecional que não pode ser descriptografada nem revertida.
A conexão com a API do MyScanner é feita por HTTPS.
Você pode usar seu token de API para autenticar a solicitação; não é preciso digitar senha.
Por exemplo, se o seu token de API for:
5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
E o número de série do seu scanner é:
111111
Então, um exemplo de URL é:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
Observação:
- Se você não tiver certeza do número de série do seu scanner LVS, consulte a Documentação do Usuário do LVS
Obtenção de uma chave de API
- Faça login no MyScanner
- Clique no nome da sua conta no canto superior direito.
- Quando o menu suspenso for exibido, clique em “Profile” (Perfil).
- Clique na guia “API Token”.
- Clique em “Generate API Token” (Gerar token de API).
- Quando a caixa de diálogo de confirmação for exibida, clique em “Generate API Token” (Gerar token de API) mais uma vez.
- Seu token de API será gerado.
O que a API oferece
Todas as informações relacionadas ao scanner que você inseriu na sua chamada à API podem ser recuperadas. Isso significa que todos os registros de escaneamento já gravados pelo MyScanner podem ser recuperados.
Direitos de acesso
Sua capacidade de acessar dados depende das permissões disponíveis para o usuário do MyScanner.
Esquema
Campos em branco:
Os campos em branco são incluídos como nulos ou “” em vez de serem omitidos.
Campos DateTime:
Todos os registros de data e hora são retornados no formato ISO 8601 AAAA-MM-DD HH:MM:SS (Exemplo: 2016-12-25 13:30:00)
Solicitações
Todas as solicitações exigem a definição de, no mínimo, dois parâmetros GET.
- O número de série1 do scanner para o qual você deseja recuperar dados
- Seu token da API do MyScanner2
Observação:
- Se você não tiver certeza do número de série do seu scanner LVS, consulte a Documentação do Usuário do LVS
- Consulte a documentação acima com relação à geração do token da API do MyScanner
Obter tudo
| OBTER | todos os registros | |||
|---|---|---|---|---|
| Caso de uso | Você deseja retornar todos os dados de digitalização de um scanner. | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
… …
]
Registro MAIOR DO QUE
| OBTER | todos os registros | > | último registro | |
|---|---|---|---|---|
| Caso de uso | Você deseja retornar todos os dados de digitalização de um scanner após o último número de registro armazenado: 111111-000017 | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
| último registro | string(13 | XXXXXX-XXXXXX | 111111-000017 | |
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&lastrecord=111111-000017&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
]
DateTime AFTER
| OBTER | todos os registros | |||
| DEPOIS | ||||
| Casos de uso | Você deseja obter todos os dados de varredura de todos os registros após a data (25 de agosto de 2015) e a hora (12:48h) | |||
| Parâmetros | NOME | TIPO | FORMATO | EXEMPLO |
| sid | string(6) | XXXXXX | 111111 | |
| após | string(19) | YYYY-MM-DD+HH:MM:SS | 2015-07-25+00:48:00 | |
Observações:
O símbolo ‘+’ separa DATA+HORA apenas para fins de codificação de URL. A API reconhece espaços em branco, ‘%20’ ou ‘+’
URL da solicitação:
https://myscannerapi.loadscan.com/api.php?sid=111111&after=25/07/2015+00:48:00&token=5ayHUgjsa952dY37PsSkydM023OiDbgsGuS2KEydBFY9i1xJOoLeHUnuOb0Bs9dQ
É possível que o último registro retornado esteja relacionado a uma varredura que ainda não foi finalizada e que pode ser cancelada após o fato pelo operador do scanner. Atualmente, se você precisar saber o status de cada registro precisamente por meio da API, precisará verificar novamente esse último registro mais tarde para ver se ele foi cancelado depois de ter sido originalmente recuperado e se outras varreduras foram processadas. Consulte as solicitações “Cancelado” e “Simples” abaixo para saber como você pode lidar com isso.
Resposta de amostra
[
,
]