Atenção: O upload de aplicativos estará disponível somente no plano Pro.
Consulte nossos planos clicando aqui!
Nossa API disponibiliza serviços e dados da Pulsus para que sua equipe de desenvolvimento simplifique processos e proporcione experiências superiores para colaboradores e clientes.
Acesse aqui para ter acesso à nossa documentação.
Com a documentação citada acima, você poderá fazer GETs, POSTs e PUTs.
Você pode usar o programa que preferir ou até mesmo o próprio link permitirá a execução.
Abaixo você verá um exemplo de requisição:
GET v1/groups
Retorna uma lista de grupos de dispositivos
Url da API
Autenticação
A API exige que seja passado o ApiToken do ambiente no cabeçalho (header) da requisição http.
Observação: Para gerar o token do seu ambiente entre em contato com nosso suporte enviando um e-mail para [email protected].
Parâmetros
Name | Description |
ApiToken string * (header)
| deve ser informado no cabeçalho da requisição HTTP |
since_id integer (query)
| Paginação - Pesquisa a partir de um id superior ao since_id informado |
max_id integer (query) | Paginação - Pesquisa ids menores que o informado em max_id |
ID string (query) | Lista de identificadores (IDs) |
* parâmetros obrigatórios
O método retornará os últimos 500 resultados. Para buscar resultados anteriores é necessário o uso do parâmetro “max_id”.
O resultado será exibido conforme os IDs, do ambiente, por exemplo
Se você limitar do id 1000 até 2000, e todos esses IDs estiverem ativos na base, o retorno será de 1000 a 1499.
Example Value (schema)
Response:
code | description |
200 | ok |
401 | Unauthorized/Invalid api token |
404 | Not Found |
422 | Unprocessable Entity |
500 | Internal Server Error |
Schemas:
Limites de consumo da Pulsus API
Para garantir a estabilidade, a segurança e a disponibilidade da plataforma, a Pulsus aplica limites ao número de requisições realizadas por meio da API, conforme a tabela abaixo:
* Cada chamada à API é contabilizada como uma requisição.
Os limites são contabilizados por ambiente Pulsus, considerando a soma das requisições realizadas por todos os tokens e integrações associados ao ambiente/conta.
O que acontece quando o limite é atingido?
Quando um dos limites de consumo for atingido, a API retornará o seguinte erro:
429 Too Many Requests
Neste caso, a integração deverá aguardar a renovação da janela de consumo antes de realizar uma nova tentativa.
Recomendamos que as integrações:
evitem consultas desnecessárias ou repetitivas;
utilizem os parâmetros de paginação e filtros disponíveis;
implementem novas tentativas com intervalos progressivos.
Após a renovação da janela, as requisições poderão ser realizadas normalmente.
Precisa de um limite maior?
Caso o volume necessário para sua integração ultrapasse o limite disponível no plano contratado, entre em contato com o suporte da Pulsus.