Parameters
- api_token - mandatory parameter. Integration token of the outsourcing provider for which you want to fetch data. This token can be obtained from the menu Settings > Integration, on the PrintWayy website;
- documentType - optional parameter. It should be used to inform the type of document to be used in the customer search, when you want to search for a specific customer. It can receive the values "CPF" or "CNPJ". If this parameter is not informed, all clients of the provider will be returned;
- documentNumber - optional parameter. It must be used to inform the CPF or CNPJ number of the client you want to search. Only numbers should be entered. If the parameter documentType is entered, this parameter must also be entered.
Format of responses
All responses to requests will have the following fields, which indicate whether the request has been fulfilled or not:
- Success - Boolean value indicating whether the request was successful or not;
- Code - code that indicates the result of the request. The possible return codes are:
- 0 - Successful request;
- 1 - The API token has not been entered or is incorrect;
- 4 - The document type you entered is invalid;
- 5 - The CPF or CNPJ number was not informed or is invalid;
- 999 - Error when requesting information. Please try again.
When the request processing finds one or more clients according to the passed parameters, in addition to the above fields, the following information will be returned for each client:
- Token - client's identification token. It can be used to query the counters of the client's printers;
- Name - name of the customer registered with PrintWayy;
- DocumentType - type of document registered for the customer in PrintWayy. It can be "CPF" or "CNPJ";
- DocumentNumber - the client's CPF or CNPJ number.
Requesting data from all the provider's clients:
Requisition:
|
1 |
https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884 |
Response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
<?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> |
Requesting data from a specific customer:
Requisition:
|
1 |
https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884&documentType=CNPJ&documentNumber=12345612345698 |
Response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<?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> |
To return to the Integration menu menu, click here.