Parámetros
- api_token - parámetro obligatorio. Token de integración del proveedor de subcontratación cuyos datos deben recuperarse. Este token puede obtenerse en el menú Configuración > Integración, en el sitio web de PrintWayy;
- documentType - parámetro opcional. Debe utilizarse para informar del tipo de documento que se utilizará en la búsqueda de clientes, cuando se quiera buscar un cliente concreto. Puede recibir los valores "CPF" o "CNPJ". Si no se informa de este parámetro, se devolverán todos los clientes del proveedor;
- documentNumber - parámetro opcional. Se debe utilizar para informar el número de CPF o CNPJ del cliente que se quiere buscar. Sólo hay que informar de los números. Si el parámetro documentType es informado, este parámetro también debe ser informado.
Formato de las respuestas
Todas las respuestas a las solicitudes tendrán los siguientes campos, que indican si la solicitud se ha cumplido o no:
- Éxito - Valor booleano que indica si la solicitud fue atendida con éxito o no;
- Código - código que indica el resultado de la solicitud. Los posibles códigos de retorno son:
- 0 - Petición satisfecha;
- 1 - El token de la API no ha sido introducido o es incorrecto;
- 4 - El tipo de documento introducido no es válido;
- 5 - El número de CPF o CNPJ no fue informado o no es válido;
- 999 - Error al solicitar información. Por favor, inténtalo de nuevo.
Cuando el procesamiento de la solicitud encuentra uno o más clientes según los parámetros pasados, además de los campos anteriores, se devolverá la siguiente información, para cada cliente:
- Ficha -ficha de identificación del cliente. Puede utilizarse para consultar los contadores de las impresoras del cliente;
- Nombre - nombre del cliente registrado en PrintWayy;
- DocumentType - tipo de documento registrado para el cliente en PrintWayy. Puede ser "CPF" o "CNPJ";
- DocumentNumber - el número de CPF o CNPJ del cliente.
Solicitar datos a todos los clientes del proveedor:
Requisición:
|
1 |
https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884 |
Respuesta:
|
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> |
Solicitud de datos de un cliente concreto:
Requisición:
|
1 |
https://ws.printwayy.com/api/Customers?api_token=453054FF-6500-4A52-996D-1BC24E226884&documentType=CNPJ&documentNumber=12345612345698 |
Respuesta:
|
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> |
Para volver al menú de integración menú, haga clic aquí.