Começar
Autenticação
Toda chamada leva a chave no header Authorization. É a chave que decide o ambiente: não existe parâmetro de ambiente na integração.
es_test_…
Produção Restrita
Testes no governo, sem valor legal.
RESTRICTED
es_live_…
Produção
O envio oficial.
PRODUCTION
A chave é de servidor para servidor. A integração não responde CORS: nunca coloque a chave no navegador nem no aplicativo do celular.
O header
Authorization: Bearer es_test_…Confira a chave
Testa a chave e diz em que ambiente ela está. Bom para o primeiro teste e para o health check do seu sistema.
GET
https://integration.enviaesocial.com.br/v1/ping
Autenticação
Bearer es_…
Corpo
Sem corpo
Sucesso
200
pong
Respostas
200
pong
A chave vale; environment diz o ambiente.
401
invalid_api_key
Chave ausente, inválida ou revogada.
Formato de toda resposta
status
texto
success ou error.
message
texto
O código do resultado, sempre de máquina: event_accepted, validation_error…
data
objeto
O recurso em data.<nome>, a lista em data.items com data.pagination, ou os erros em data.errors. Sem nada a devolver, a resposta vem sem data.