API Terceros/Notas Tercero - Historial de revisiones

https://www.wikiserpi.com/index.php?action=history&feed=atom&title=API_Terceros%2FNotas_Tercero API Terceros/Notas Tercero - Historial de revisiones 2026-11-10T03:45:13Z Historial de revisiones de esta página en la wiki MediaWiki 1.43.0 https://www.wikiserpi.com/index.php?title=API_Terceros/Notas_Tercero&diff=939&oldid=prev Dvaldes: /* ¿Cómo consumir la API? */ 2023-07-28T16:41:47Z

<p><span class="autocomment">¿Cómo consumir la API?</span></p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="es"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Revisión anterior</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revisión del 11:41 28 jul 2023</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l304">Línea 304:</td> <td colspan="2" class="diff-lineno">Línea 304:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>RequestBody body = RequestBody.create(mediaType, "");</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>RequestBody body = RequestBody.create(mediaType, "");</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Request request = new Request.Builder()</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Request request = new Request.Builder()</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> .url("https://<del style="font-weight: bold; text-decoration: none;">localhost:44305</del>/api/v1/NotaTercero")</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div> .url("https://<ins style="font-weight: bold; text-decoration: none;">apis.serpi.com.co</ins>/api/v1/NotaTercero")</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> .method("GET", body)</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> .method("GET", body)</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> .addHeader("secretkey", "{{secret key}}")</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> .addHeader("secretkey", "{{secret key}}")</div></td></tr> <tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l317">Línea 317:</td> <td colspan="2" class="diff-lineno">Línea 317:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><syntaxhighlight lang="c#"></div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><syntaxhighlight lang="c#"></div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>var client = new HttpClient();</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>var client = new HttpClient();</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>var request = new HttpRequestMessage(HttpMethod.Get, "https://<del style="font-weight: bold; text-decoration: none;">localhost:44305</del>/api/v1/NotaTercero");</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>var request = new HttpRequestMessage(HttpMethod.Get, "https://<ins style="font-weight: bold; text-decoration: none;">apis.serpi.com.co</ins>/api/v1/NotaTercero");</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>request.Headers.Add("secretkey", "{{secret key}}");</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>request.Headers.Add("secretkey", "{{secret key}}");</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>request.Headers.Add("Authorization", "Bearer{{token}}");</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>request.Headers.Add("Authorization", "Bearer{{token}}");</div></td></tr> <tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l334">Línea 334:</td> <td colspan="2" class="diff-lineno">Línea 334:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>require_once 'HTTP/Request2.php';</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>require_once 'HTTP/Request2.php';</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request = new HTTP_Request2();</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request = new HTTP_Request2();</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>$request->setUrl('https://<del style="font-weight: bold; text-decoration: none;">localhost:44305</del>/api/v1/NotaTercero');</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>$request->setUrl('https://<ins style="font-weight: bold; text-decoration: none;">apis.serpi.com.co</ins>/api/v1/NotaTercero');</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request->setMethod(HTTP_Request2::METHOD_GET);</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request->setMethod(HTTP_Request2::METHOD_GET);</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request->setConfig(array(</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>$request->setConfig(array(</div></td></tr> </table>

Dvaldes https://www.wikiserpi.com/index.php?title=API_Terceros/Notas_Tercero&diff=574&oldid=prev Dvaldes: /* Métodos */ 2023-06-20T15:42:52Z

<p><span class="autocomment">Métodos</span></p> <a href="https://www.wikiserpi.com/index.php?title=API_Terceros/Notas_Tercero&diff=574&oldid=572">Mostrar los cambios</a>

Dvaldes https://www.wikiserpi.com/index.php?title=API_Terceros/Notas_Tercero&diff=572&oldid=prev Dvaldes: /* Métodos */ 2023-06-20T15:15:58Z

<p><span class="autocomment">Métodos</span></p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="es"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Revisión anterior</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revisión del 10:15 20 jun 2023</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l23">Línea 23:</td> <td colspan="2" class="diff-lineno">Línea 23:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>'''EndPoint con parámetros:'''</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>'''EndPoint con parámetros:'''</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><nowiki>https://www.apis.serpi.com.co/api/v1/NotaTercero?<del style="font-weight: bold; text-decoration: none;">limite</del>=<del style="font-weight: bold; text-decoration: none;">50&pagina=1</del></nowiki></div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><nowiki>https://www.apis.serpi.com.co/api/v1/NotaTercero?<ins style="font-weight: bold; text-decoration: none;">nitTercero</ins>=<ins style="font-weight: bold; text-decoration: none;">1075229539</ins></nowiki></div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="wikitable"</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>{| class="wikitable"</div></td></tr> <tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l47">Línea 47:</td> <td colspan="2" class="diff-lineno">Línea 47:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|-</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página</div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">|-</ins></div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">| nitTercero || int || No || Este parámetro indica el NIT del tercero. Se devolverán las notas relacionadas a ese tercero</ins></div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>|}</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> </table>

Dvaldes https://www.wikiserpi.com/index.php?title=API_Terceros/Notas_Tercero&diff=571&oldid=prev Dvaldes: Página creada con «'''Descripción:''' PENDIENTE '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP. '''Beneficio:''' PENDIENTE '''Tipos de peticiones:''' GET, POST, PUT '''¿Cómo funciona?''' PENDIENTE == Métodos == <Tabs> <!-- ***************************************************…» 2023-06-20T15:06:20Z

<p>Página creada con «'''Descripción:''' PENDIENTE '''Autorización:''' Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP. '''Beneficio:''' PENDIENTE '''Tipos de peticiones:''' GET, POST, PUT '''¿Cómo funciona?''' PENDIENTE == Métodos == <Tabs> <br /> <Tab name = "API Consulta (GET) "><br /> <br /> '''EndPoint:'''<br /> https://www.apis.serpi.com.co/api/v1/NotaTercero<br /> <br /> '''EndPoint con parámetros:'''<br /> <nowiki>https://www.apis.serpi.com.co/api/v1/NotaTercero?limite=50&pagina=1</nowiki><br /> <br /> {| class="wikitable"<br /> |+ Headers<br /> |-<br /> ! Header !! Descripción <br /> |-<br /> | secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br /> |}<br /> <br /> '''Authorization:'''<br /> <syntaxhighlight ><br /> Usar Bearer. Ejemplo “bearer {{token}}”.<br /> {{token}} Token de autorizacion generado por SerpiERP<br /> </syntaxhighlight><br /> <br /> {| class="wikitable"<br /> |+ Parámetros<br /> |-<br /> ! Parámetro !! Tipo de dato !! Requerido !! Descripción<br /> |-<br /> | Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página<br /> |-<br /> | Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página<br /> |}<br /> <br /> '''Response'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "success": true,<br /> "code": 200,<br /> "errors": null,<br /> "message": "1 registro(s) encontrados",<br /> "result": [<br /> {<br /> "id": 1,<br /> "descripcion": "LISTA DE PRECIO DEMO",<br /> "fechavigencia": "2019-05-21",<br /> "codigo": "0",<br /> "lista_predeterminada": true,<br /> "permiso_especial": true<br /> }<br /> ]<br /> }<br /> <br /> {<br /> "success": true<br /> "code": 201,<br /> "message": "No se encontraron registros",<br /> "result": []<br /> }<br /> </syntaxhighlight><br /> <br /> {| class="wikitable"<br /> |+ Campos de resultados<br /> |-<br /> ! Campo !! Tipo de dato !! Descripción<br /> |-<br /> | id || int || Corresponde al identificador de la lista de precio<br /> |-<br /> | descripcion || string || Descripción de la lista de precio<br /> |-<br /> | fechavigencia || Date || Fecha Vigencia<br /> |-<br /> | codigo || string|| Código<br /> |-<br /> | lista_predeterminada || bool || Lista Predeterminada<br /> |-<br /> | permiso_especial || bool || Permiso especial para Ver<br /> |}<br /> </Tab><br /> <br /> <br /> <Tab name = "API Creación (POST) "><br /> '''EndPoint:'''<br /> https://www.apis.serpi.com.co/api/v1/NotaTercero<br /> <br /> {| class="wikitable"<br /> |+ Headers<br /> |-<br /> ! Header !! Descripción <br /> |-<br /> | secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br /> |}<br /> <br /> '''Authorization:'''<br /> <syntaxhighlight><br /> Usar Bearer. Ejemplo “bearer {{token}}”.<br /> {{token}} Token de autorizacion generado por SerpiERP<br /> </syntaxhighlight><br /> <br /> <br /> '''Request'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "descripcion": "LISTA DE PRECIO DEMO",<br /> "fechavigencia": "2023-06-19",<br /> "codigo": "4",<br /> "lista_predeterminada": true,<br /> "permiso_especial": true<br /> }<br /> </syntaxhighlight><br /> <br /> <br /> {| class="wikitable"<br /> |+ Campos del request<br /> |-<br /> ! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción<br /> |-<br /> | descripcion || string || 100 || Si || Descripción de la lista de precio<br /> |-<br /> | fechavigencia || Date || '''YYYY-MM-DD''' || Si || Fecha Vigencia<br /> |-<br /> | codigo || string || 30 || Si || Código único de la lista de precio<br /> |-<br /> | lista_predeterminada || bool || 1 || No || Lista Predeterminada<br /> |-<br /> | permiso_especial || bool || 1 || No || Permiso especial para Ver<br /> |}<br /> <br /> ==== '''AVISO IMPORTANTE:''' ====<br /> Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.<br /> <br /> <br /> '''Response'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "success": true,<br /> "code": 201,<br /> "errors": [],<br /> "message": "Validaciones exitosas. Registro creado exitosamente"<br /> }<br /> </syntaxhighlight><br /> <br /> '''Validaciones'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "success": false,<br /> "code": 400,<br /> "errors": [<br /> "El codigo 1 ya existe",<br /> "El campo descripcion es obligatorio",<br /> "El campo de fechavigencia es inválido. Formato esperado: yyyy-MM-dd"<br /> ],<br /> "message": "Problemas de validaciones. Se presentaron errores al crear el registro"<br /> }<br /> </syntaxhighlight><br /> </Tab><br /> <br /> <br /> <Tab name = "API Modificar(PUT) "><br /> '''EndPoint:'''<br /> https://www.apis.serpi.com.co/api/v1/NotaTercero<br /> <br /> {| class="wikitable"<br /> |+ Headers<br /> |-<br /> ! Header !! Descripción <br /> |-<br /> | secretkey || Secretkey proporcionada al cliente para consumos de las APIs<br /> |}<br /> <br /> '''Authorization:'''<br /> <syntaxhighlight><br /> Usar Bearer. Ejemplo “bearer {{token}}”.<br /> {{token}} Token de autorizacion generado por SerpiERP<br /> </syntaxhighlight><br /> <br /> <br /> '''Request'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "id": 1,<br /> "descripcion": "LISTA DE PRECIO DEMO MODIFICADA",<br /> "fechavigencia": "2022-05-21",<br /> "codigo": "5",<br /> "lista_predeterminada": false,<br /> "permiso_especial": false<br /> }<br /> </syntaxhighlight><br /> <br /> <br /> {| class="wikitable"<br /> |+ Campos del request<br /> |-<br /> ! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción<br /> |-<br /> | id || int || 11 || Si || Corresponde al identificador de la lista de precio<br /> |-<br /> | descripcion || string || 100 || Si || Descripción de la lista de precio<br /> |-<br /> | fechavigencia || Date || '''YYYY-MM-DD''' || Si || Fecha Vigencia<br /> |-<br /> | codigo || string || 30 || Si || Código único de la lista de precio<br /> |-<br /> | lista_predeterminada || bool || 1 || No || Lista Predeterminada<br /> |-<br /> | permiso_especial || bool || 1 || No || Permiso especial para Ver<br /> |}<br /> <br /> ==== '''AVISO IMPORTANTE:''' ====<br /> Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.<br /> <br /> <br /> '''Response'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "success": true,<br /> "code": 200,<br /> "errors": [],<br /> "message": "Validaciones exitosas. Registro modificado exitosamente"<br /> }<br /> <br /> {<br /> "success": false,<br /> "code": 204,<br /> "errors": null,<br /> "message": "No se encontraron registros con el id 1"<br /> }<br /> </syntaxhighlight><br /> <br /> '''Validaciones'''<br /> <syntaxhighlight lang="JSON"><br /> {<br /> "success": false,<br /> "code": 400,<br /> "errors": [<br /> "El campo id es obligatorio",<br /> "El codigo 1 ya esta asociado a otro id",<br /> "El campo descripcion es obligatorio",<br /> "El campo fechavigencia es obligatorio",<br /> "El campo de fechavigencia es inválido. Formato esperado: yyyy-MM-dd"<br /> ],<br /> "message": "Problemas de validaciones. Se presentaron errores al modificar el registro"<br /> }<br /> </syntaxhighlight><br /> </Tab><br /> </Tabs><br /> <br /> == Códigos de estado HTTP ==<br /> {| class="wikitable left"<br /> ! Código !! Descripción<br /> |-<br /> | 200 || La solicitud ha sido exitosa<br /> |-<br /> | 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso<br /> |-<br /> | 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta<br /> |-<br /> | 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente<br /> |-<br /> | 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso<br /> |-<br /> | 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso<br /> |-<br /> | 404 || El recurso solicitado no se ha encontrado en el servidor<br /> |-<br /> | 500 || Internal Server Error<br /> |-<br /> | 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal<br /> |}<br /> <br /> == ¿Cómo consumir la API? ==<br /> <br /> <Tabs><br /> <br /> <Tab name = "Java"><br /> '''Request'''<br /> <syntaxhighlight lang="java"><br /> OkHttpClient client = new OkHttpClient().newBuilder()<br /> .build();<br /> MediaType mediaType = MediaType.parse("text/plain");<br /> RequestBody body = RequestBody.create(mediaType, "");<br /> Request request = new Request.Builder()<br /> .url("https://localhost:44305/api/v1/NotaTercero")<br /> .method("GET", body)<br /> .addHeader("secretkey", "{{secret key}}")<br /> .addHeader("Authorization", "Bearer{{token}}")<br /> .build();<br /> Response response = client.newCall(request).execute();<br /> </syntaxhighlight><br /> </Tab><br /> <br /> <Tab name = "C#"><br /> '''Request'''<br /> <syntaxhighlight lang="c#"><br /> var client = new HttpClient();<br /> var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/NotaTercero");<br /> request.Headers.Add("secretkey", "{{secret key}}");<br /> request.Headers.Add("Authorization", "Bearer{{token}}");<br /> var content = new StringContent("", null, "text/plain");<br /> request.Content = content;<br /> var response = await client.SendAsync(request);<br /> response.EnsureSuccessStatusCode();<br /> Console.WriteLine(await response.Content.ReadAsStringAsync());<br /> </syntaxhighlight><br /> </Tab><br /> <br /> <Tab name = "PHP"><br /> '''Request'''<br /> <syntaxhighlight lang="php"><br /> <?php<br /> require_once 'HTTP/Request2.php';<br /> $request = new HTTP_Request2();<br /> $request->setUrl('https://localhost:44305/api/v1/NotaTercero');<br /> $request->setMethod(HTTP_Request2::METHOD_GET);<br /> $request->setConfig(array(<br /> 'follow_redirects' => TRUE<br /> ));<br /> $request->setHeader(array(<br /> 'secretkey' => '{{secret key}}',<br /> 'Authorization' => 'Bearer {{token}}'<br /> ));<br /> $request->setBody('');<br /> try {<br /> $response = $request->send();<br /> if ($response->getStatus() == 200) {<br /> echo $response->getBody();<br /> }<br /> else {<br /> echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .<br /> $response->getReasonPhrase();<br /> }<br /> }<br /> catch(HTTP_Request2_Exception $e) {<br /> echo 'Error: ' . $e->getMessage();<br /> }<br /> </syntaxhighlight><br /> </Tab><br /> <br /> </Tabs><br /> <br /> [[Category:Documentación APIs]]<br /> </div>

Dvaldes