---
updatedAt: 2025-11-10T23:38:01.000Z
agentTools:
  projectIndex: https://developer.sankhya.com.br/llms.txt
---

# API de Serviços (XML)

## Apresentação

A API de serviços da plataforma Sankhya se dispõe a fornecer um meio de integração com outros sistemas de forma fácil e independente de tecnologia.

Essa API é baseada em chamadas HTTP/HTTPS do tipo POST e GET,  com corpo no formato XML.\
Portanto, qualquer sistema que possuir capacidade de realizar uma chamada HTTP/HTTPS convencional poderá fazer uso dos diversos serviços fornecidos pela API.

> 📘 Informação Importante
>
> As informações nesse artigo tratam exclusivamente de requisições com estruturação em XML. Para requisições com corpo em JSON acesse o artigo [API de Serviços](https://developer.sankhya.com.br/docs/api-de-servi%C3%A7os).

## URL de chamada

A URL de requisição possui sempre o mesmo padrão, independente do serviço a ser utilizado:

<https://api.sankhya.com.br/gateway/v1[modulo]/service.sbr?serviceName=[nomedoserviço]>

## Padrão do envelope XML

**Requisição**\
Como dito anteriormente, todas as chamadas são do tipo POST e possuem um corpo XML com os parâmetros da chamada. Esses parâmetros são específicos por serviço e são envolvidos por um conjunto de elementos que representam um envelope de chamada, como neste exemplo:

```xml
<serviceRequest serviceName="[nome.do.serviço]">
  <requestBody>
    <!-- elementos específicos de cada serviço aqui -->
  </requestBody>
</serviceRequest>
```

O uso da declaração \<?xml> é opcional.

**Headers HTTP obrigatórios:**\
Content-type = text/xml;charset=ISO-8859-1\
User-Agent = \[qualquer valor, desde que não vazio]

**Resposta**\
Todos os serviços retornam uma resposta no formato XML, como neste exemplo:

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<serviceResponse serviceName="[nome.do.serviço]" status="1">
    <responseBody>
<!-- 
elemento(s) com o conteúdo da resposta, específico para cada serviço 
-->
    </responseBody>
<!-- elemento opcional de alertas e mensagens -->
    <statusMessage>
        <![CDATA[mensagem de erro ou alerta em formato base64]]>
    </statusMessage>
</serviceResponse>
```

O exemplo acima mostra uma resposta bem sucedida (status = 1), porém existem outros status com significados específicos:

**0 = ERROR**\
A chamada do serviço terminou no servidor com erro. Neste caso o elemento \<statusMessage> será retornado com a mensagem de erro em formato base 64.

**1 = OK**\
A chamada foi bem sucedida e a resposta está presente em \<responseBody>. Alguns serviços não possuem resposta relevante, portanto o elemento \<responseBody> pode ser vazio.

**2 = INFO**\
Mesmo significado de OK (1), no entanto o elemento \<statusMessage> possui mensagem de aviso ou alerta.

**3 = TIMEOUT**\
A sessão com o servidor terminou por tempo de inoperância excedido. Um outro procedimento de login será necessário para usar serviços.

**4 = SERVICE\_CANCELED**\
O serviço se deparou com uma situação onde precisa de mais informações para ser executado. Neste caso um elemento \<clientEvents> também será retornado. O uso deste tipo de recurso está fora do escopo deste documento, portanto, em casos de ocorrência, a Central Sankhya deverá ser consultada.

## Requisições em JSON

Confira no link abaixo a documentação da API de integração em JSON

<HTMLBlock>{`
<div class="center">
 <a class="button_background button_size"
                    href="https://developer.sankhya.com.br/reference/api-de-integra%C3%A7%C3%B5es-sankhya"
                    rel="noopener noreferrer">Requisições em JSON</a>
</div>

<style>
    
   .center {
       display: flex;
       justify-content: center;
       align-items: center;
       height: 100px;
   }
  
   .button_size {
       background-color: #4CAF50;
  		 border: none;
  		 color: white;
 			 padding: 15px 32px;
  		 text-align: center;
       text-decoration: none !important;
       display: inline-block;
       font-size: 16px;
       margin: 4px 2px;
       cursor: pointer;
       box-shadow: 0 8px 16px 0 rgba(0,0,0,0.2), 0 6px 20px 0 rgba(0,0,0,0.19);

    }

    .button_background {
        background-color: #66cc66;
        color: #fff !important;
    }

</style>
`}</HTMLBlock>

## Como tirar dúvidas?

Para tirar dúvidas e compartilhar informações, use a sala [API de Integração](https://comunidade.sankhya.com.br/c/integracao/api-de-integracao/39) da comunidade Sankhya Developer.