| Central de Ajuda | PrintWayy Dragon

Parâmetros

api_token – parâmetro obrigatório. Token de integração do provedor de outsourcing para o qual deseja-se buscar os dados. Este token pode ser obtido através do menu Configurações > Integração, no site do PrintWayy;
documentType – parâmetro opcional. Deve ser usado para informar o tipo de documento a ser utilizado na pesquisa de clientes, quando se desejar buscar um cliente específico. Pode receber os valores “CPF” ou “CNPJ”. Se este parâmetro não for informado, serão retornados todos os clientes do provedor;
documentNumber – parâmetro opcional. Deve ser usado para informar o número do CPF ou CNPJ do cliente que se deseja buscar. Devem ser informados apenas números. Se o parâmetro documentType for informado, este parâmetro também deverá ser.

Formato das respostas

Todas as respostas às solicitações terão os seguintes campos, que indicam se a requisição foi atendida ou não:

Sucess – valor booleano indicando se requisição foi atendida com sucesso ou não;
Code – código que indica o resultado da requisição. Os possíveis códigos de retorno são:
- 0 – Requisição atendida com sucesso;
- 1 – O token de API não foi informado ou está incorreto;
- 4 – O tipo de documento informado é inválido;
- 5 – O número do CPF ou CNPJ não foi informado ou é inválido;
- 999 – Erro na solicitação das informações. Tentar novamente.

Quando o processamento da requisição encontrar um ou mais clientes de acordo com os parâmetros passados, além dos campos acima, serão retornadas as seguintes informações, para cada cliente:

Token – token de identificação do cliente. Poderá ser usado nas consultas de contadores das impressoras do cliente;
Name – nome do cliente cadastrado no PrintWayy;
DocumentType – tipo de documento cadastrado para o cliente no PrintWayy. Poderá ser “CPF” ou “CNPJ”;
DocumentNumber – número do CPF ou CNPJ do cliente.

Solicitação de dados de todos os clientes do provedor:

Requisição:

https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884

1	https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884

Resposta:

<?xml version="1.0" encoding="UTF-8"?>
<BaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="CustomersResponse" xmlns="http://schemas.datacontract.org/2004/07/Southwayy.PrintWayy.WebService.Models">
  <Code>0</Code>
  <Success>true</Success>
  <Customers>
    <Customer>
      <Token>51B29CDD-C160-4638-B3A0-478C9ADD254D</Token>
      <Name>Cliente 1 LTDA</Name>
      <DocumentType>CNPJ</DocumentType>
      <DocumentNumber>12345678901234</DocumentNumber>
    </Customer>
    <Customer>
      <Token>E2D4FBB3-A374-48F5-AFD6-8217776D72F6</Token>
      <Name>Cliente 2 SA</Name>
      <DocumentType>CNPJ</DocumentType>
      <DocumentNumber>11122233344455</DocumentNumber>
    </Customer>
    <Customer>
      <Token>24FC1322-05BF-433E-8116-5992E3BB1738</Token>
      <Name>Cliente 3 ME</Name>
      <DocumentType>CNPJ</DocumentType>
      <DocumentNumber>12345612345698</DocumentNumber>
    </Customer>
    <Customer>
      <Token>D57CD4C9-3C4A-425E-9161-EFB5D5D19EDF</Token>
      <Name>Cliente pessoa fisica</Name>
      <DocumentType>CPF</DocumentType>
      <DocumentNumber>12345678901</DocumentNumber>
    </Customer>
    <Customer>
      <Token>95DC719A-1127-4939-87B1-D8E85F5891C8</Token>
      <Name>Cliente N</Name>
      <DocumentType>CNPJ</DocumentType>
      <DocumentNumber>99988877766655</DocumentNumber>
    </Customer>
  </Customers>
</BaseResponse>

<?xml version="1.0" encoding="UTF-8"?>

<Name>Cliente 1 LTDA</Name>

</Customer>

<Name>Cliente 2 SA</Name>

</Customer>

<Name>Cliente 3 ME</Name>

</Customer>

<Name>Cliente pessoa fisica</Name>

</Customer>

<Name>Cliente N</Name>

</Customer>

</Customers>

</BaseResponse>

Solicitação de dados de um cliente específico:

Requisição:

https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884&documentType=CNPJ&documentNumber=12345612345698

1	https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884&documentType=CNPJ&documentNumber=12345612345698

Resposta:

<?xml version="1.0" encoding="UTF-8"?>
<BaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="CustomersResponse" xmlns="http://schemas.datacontract.org/2004/07/Southwayy.PrintWayy.WebService.Models">
  <Code>0</Code>
  <Success>true</Success>
  <Customers>
    <Customer>
      <Token>24FC1322-05BF-433E-8116-5992E3BB1738</Token>
      <Name>Cliente 3 ME</Name>
      <DocumentType>CNPJ</DocumentType>
      <DocumentNumber>12345612345698</DocumentNumber>
    </Customer>
  </Customers>
</BaseResponse>

<?xml version="1.0" encoding="UTF-8"?>

<Name>Cliente 3 ME</Name>

</Customer>

</Customers>

</BaseResponse>

Para voltar ao menu Integração clique aqui.

Was this article helpful?

Yes No

Buscando dados de clientes

Parâmetros

Formato das respostas

Solicitação de dados de todos os clientes do provedor:

Solicitação de dados de um cliente específico:

Was this article helpful?

Related Articles