Introdução

O Sienge Plataforma disponibiliza a documentação das APIs de forma pública para clientes, parceiros de integração ou desenvolvedores independentes.

URL E requisições

Além de realizar a autenticação com o usuário e senha no momento da requisição às APIs, é necessário informar o seu sub domínio que identifica qual será o cliente Sienge que receberá a requisição. Essa informação irá complementar a url para qual será realizada chamada na API.

Exemplo:

https://api.sienge.com.br/{subdonimio-do-cliente}/public/api/{versão-da-api}/{recurso}

Exemplo:

URL Final: https://api.sienge.com.br/minhaempresa/public/api/v1/examples

É importante Ressaltar que a URL para APIs BULK DATA são diferentes, como a seguir:

https://api.sienge.com.br/minhaempresa/public/api/bulk-data/v1/examples

Lembre-se de sempre utilizar criptografia, ou seja, HTTPS… ; )

Limites de Requisições - Rate-Limits

Por padrão todos os endpoints da API dividem um número máximo de requisições por dia, que é definido pelo pacote contratado ou uma limitação de segurança por minuto, conforme a seguir.

Limites de Segurança

O limite máximo de requisições por Segurança são calculadas no volume de requisições a ser feito por um cliente (sub domínio).

As limitações são bloqueantes pelo volume por minuto conforme tabela abaixo.

Tipos Requisiçoes
REST 200 / minuto
BULK 20 / minuto

Neste caso, um usuário pode requisitar quantos endpoints achar necessário respeitando este limite..

Limites por pacotes de API

Na determinação de limites por pacotes, são contabilizadas as requisições por dia, onde pode ou não haver um bloqueio ao atingir a quota diária.

Pacotes de APIs

Neste caso, um usuário pode requisitar quantos endpoints achar necessário respeitando este limite..

Free Start Special Essencial Enterprise Ultimate
Requisições Diárias
REST 100* 1.000 2.500 5.000 10.000 75.000
BULK 10* 20* 50* 100* 200* 28.800*

* Volumes com bloqueio - Ao atingir o limite receberá o retorno 429 : To Many Requests

Autenticação

Para utilizar os recursos das APIs do Sienge Plataforma é necessário se autenticar utilizando o Basic Authorization com as credenciais cadastradas no Painel de Integrações da Plataforma. 

Se você não tem esse acesso. Contate o Administrador da sua conta Sienge Plataforma.

As diretivas de tipo Basic e credenciais devem ser informadas no Header da requisição Authorization.

As credenciais devem ser construídas da forma a seguir:

Authorization: Basic dXN1YXJpby1hcGk6c2VuaGE=