Bem vido(a) à documentação do Webservice da TenFront (V1.0). Os recursos aqui dispostos são suplementados com exemplos de respostas esperadas, para nortear a implementação. Caso haja algum empecilho ou erro não esperado, fique à vontade para chamar o suporte em TI pelos canais que você já conhece.
Observação: Utilize sempre os cabeçalhos Content-Type como application/json.
URL Base
Para realizar cada uma das chamadas API você precisará fazer a requisição para o seu respectivo endpoint, após informar o URL base:
| Ambiente | Uso | URL |
|---|---|---|
| Produção | Público | https://api.tenfront.com.br/v1/ |
Paginação
Para navegar nos recursos de listagem através de suas páginas, utilize os parâmeros dispostos na tabela abaixo
| Parâmetro | Formato | Descrição |
|---|---|---|
Page | Número (ex.: 1) | Corresponde à pagina que você deseja exibir os dados |
Conhecendo os erros comuns
Dependendo de cada requisição, você pode enfrentar algum erro, que pode ter diferentes significados e você pode se orientar pela descrição abaixo disposta:
| Status code | Tipo | Descrição |
|---|---|---|
200 | Sucesso | Requisição processada com sucesso. |
201 | Sucesso com registro | Requisição válida, com criação de log ou registro. |
400 | Erro do cliente | Parâmetros ausentes ou malformados. |
401 | Não encontrado | Chave não encontrada ou empresa não registrada. |
402 | Não autorizado | Chave de autorização inválida ou ausente. |
403 | Proibido | Acesso bloqueado por regras do sistema. |
429 | Limite atingido | Limite de requisições atingido |
Requisição autenticada
Para que seja possível autenticar-se no webservice, a integração precisa comtemplar os itens constados na tabela abaixo:
| Item | Campo obrigatório | Descrição |
|---|---|---|
Content-Type | Sim, obrigatório | application/json |
Authorization | Sim, obrigatório | Informar seu bearer access token. |
Consumer-key | Sim, obrigatório | Informar sua consumer key. |
Consumer-secret | Sim, obrigatório | Informar sua consumer secret. |
Observação: Você pode visualizar as suas chaves API clicando aqui.
Limites de taxa e uso
Para realizar as requisições através do webservice, cada empresa na plataforma tem uma limitação de taxa e uso, com o objetivo de manter o serviço estável e acessível para toda a base, sem comprometer o acesso aos demais.
- Os limites de acesso à API são aplicados por chave de API.
- O limite é de 10 requisições por minuto. Além disso, dependendo do seu plano, você pode ter limites de uso.
- Se você exceder qualquer um desses limites, sua solicitação retornará um
status code 429.
Cada empresa tem um limite de requisições de acordo com o plano contratado, podendo ser consultado na tabela abaixo:
| Item | Limite de taxa | Rate limit |
|---|---|---|
Essencial | 10 requisições por minuto | 100 requisições diárias. |
Gerencial | 10 requisições por minuto | 200 requisições diárias. |
Estratégia | 10 requisições por minuto | 350 requisições diárias. |
Precisa de alguma ajuda?
Caso tenha dúvidas, não hesite em falar com nosso equipe especializada pelos canais que você já conhece.