Diferencia entre revisiones de «API Documentos Contables/Sucursales»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
Edición siguiente →
VisualWikitexto
Página creada con «'''Descripción:''' Esta API permite la sincronizacion de sucursales entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas. '''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:''' '''Tipos de petici…»
 
Línea 402: Línea 402:
<Tab name = "Java">
<Tab name = "Java">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
   .build();
Línea 408: Línea 408:
RequestBody body = RequestBody.create(mediaType, "");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
Request request = new Request.Builder()
   .url("https:///www.apis.serpi.com.co/api/v1/Sucursales")
   .url("https://localhost:44305/api/v1/Sucursales")
   .method("GET", body)
   .method("GET", body)
   .addHeader("secretkey", "{Secret Key}")
   .addHeader("secretkey", "{{secret key}}")
   .addHeader("Authorization", "{Bearer Token}")
   .addHeader("Authorization", "Bearer{{token}}")
   .build();
   .build();
Response response = client.newCall(request).execute();
Response response = client.newCall(request).execute();
</syntaxhighlight>
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


<Tab name = "Python">
<Tab name = "C#">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="c#">
import requests
var client = new HttpClient();
 
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Sucursales");
url = "https://www.apis.serpi.com.co/api/v1/Sucursales"
request.Headers.Add("secretkey", "{{secret key}}");
 
request.Headers.Add("Authorization", "Bearer{{token}}");
payload = {}
var content = new StringContent("", null, "text/plain");
headers = {
request.Content = content;
  'secretkey': '{Secret Key}',
var response = await client.SendAsync(request);
  'Authorization': '{Bearer Token}'
response.EnsureSuccessStatusCode();
}
Console.WriteLine(await response.Content.ReadAsStringAsync());
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)
 
</syntaxhighlight>
 
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


<Tab name = "Php">
<Tab name = "PHP">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="php">
<?php
<?php
require_once 'HTTP/Request2.php';
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Sucursales');
$request->setUrl('https://localhost:44305/api/v1/Sucursales');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
$request->setConfig(array(
Línea 483: Línea 444:
));
));
$request->setHeader(array(
$request->setHeader(array(
   'secretkey' => '{Secret Key}',
   'secretkey' => '{{secret key}}',
   'Authorization' => '{Bearer Token}'
   'Authorization' => 'Bearer{{token}}'
));
));
$request->setBody('');
try {
try {
   $response = $request->send();
   $response = $request->send();
Línea 498: Línea 460:
catch(HTTP_Request2_Exception $e) {
catch(HTTP_Request2_Exception $e) {
   echo 'Error: ' . $e->getMessage();
   echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
}
</syntaxhighlight>
</syntaxhighlight>
Línea 520: Línea 465:


</Tabs>
</Tabs>
''' Códigos de estado HTTP'''
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}


[[Category:Documentación APIs]]
[[Category:Documentación APIs]]
<!-- [[Category:Pages with syntax highlighting errors]] -->
<!-- [[Category:Pages with syntax highlighting errors]] -->

Revisión del 15:55 16 jun 2023

Descripción: Esta API permite la sincronizacion de sucursales entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

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:

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta (GET) "> GET/users

EndPoint: https://www.apis.serpi.com.co/api/v1/Sucursales


Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro Tipo de dato Requerido Descripción
Límite int No Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
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

Response 

{
"success": true
	"success": true,
    "code": 200,
    "errors": null,
    "message": "x registro(s) encontrados",
    "result": [
        {
            "id": 2317,
            "id_tercero": 1804,
            "nit_tercero": "900985549",
            "codigo": 0,
            "referencia_sucursal": "",
            "descripcion": "PRUEBA",
            "direccion": "cra 22 # 4-44",
            "direccion2": "",
            "telefono": "",
            "telefono2": "",
            "ext": null,
            "ext2": null,
            "movil": "",
            "id_ciudad": 5001,
            "codigo_ciudad": "05001",
            "id_departamento": 5,
            "codigo_departamento": "05",
            "id_pais": 1,
            "codigo_pais": "57",
            "id_vendedor": 3418,
            "id_cobrador": null,
            "es_direccionCobro": false,
            "es_direccionDespacho": false
        },
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campo de resultados

Campo Tipo de dato Descripción
id int Corresponde al identificador de la sucursal
id_tercero int Corresponde al identificador del tercero
nit_tercero int Nit del tercero
codigo string Codigo de la sucursal
referencia_sucursal string Referencia de la sucursal
descripcion string Descripcion de la sucursal
direccion string Direccion de la sucursal
direccion2 string Segunda direccion de la sucursal
telefono int Telefono correspondiente a la sucursal
telefono2 int Segundo telefono correspondiente a la sucursal
ext int Extension de la sucursal
ext2 int Extension de la sucursal
movil int Celular de la sucursal
id_ciudad int Identificador correspondiente a la ciudad de la sucursal
codigo_ciudad string Codigo de la ciudad de la sucursal
id_departamento int Identificador correspondiente al departamento de la sucursal
codigo_departamento string Codigo del departamento de la sucursal
id_pais int Identificador correspondiente al pais de la sucursal
codigo_pais string Codigo del pais de la sucursal
id_vendedor int Identificador correspondiente al vendedor de la sucursal
id_cobrador int Identificador correspondiente al cobrador de la sucursal
es_direccionCobro bool Valida si es direccion de cobro
es_direccionDespacho bool Valida si es direccion de despacho

</Tab>

<Tab name = "API Creación (POST) "> POST /users

EndPoint: https://www.apis.serpi.com.co/api/v1/Sucursales

Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request 

{
    "id_tercero": 1804,
    "nit_tercero": "900985549",
    "codigo": 0,
    "referencia_sucursal": null,
    "descripcion": "PRUEBA",
    "direccion": "cra 22 #4-44",
    "direccion2": null,
    "telefono": null,
    "telefono2": null,
    "ext": null,
    "ext2": null,
    "movil": null,
    "id_ciudad": 5001,
    "codigo_ciudad": "05001",
    "id_departamento": 5,
    "codigo_departamento": "05",
    "id_pais": 1,
    "codigo_pais": "57",
    "id_vendedor": 3418,
    "id_cobrador": null,
    "es_direccionCobro": false,
    "es_direccionDespacho": false
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
id_tercero int 50 SI Corresponde al identificador del tercero
nit_tercero int 50 SI Nit del tercero
codigo string 50 SI Codigo de la sucursal
referencia_sucursal string 50 SI Referencia de la sucursal
descripcion string 50 SI Descripcion de la sucursal
direccion string 50 SI Direccion de la sucursal
direccion2 string 50 NO Segunda direccion de la sucursal
telefono int 50 SI Telefono correspondiente a la sucursal
telefono2 int 50 NO Segundo telefono correspondiente a la sucursal
ext int 50 NO Extension de la sucursal
ext2 int 50 NO Extension de la sucursal
movil int 50 NO Celular de la sucursal
id_ciudad int 50 SI Identificador correspondiente a la ciudad de la sucursal
codigo_ciudad string 50 SI Codigo de la ciudad de la sucursal
id_departamento int 50 SI Identificador correspondiente al departamento de la sucursal
codigo_departamento string 50 SI Codigo del departamento de la sucursal
id_pais int 50 SI Identificador correspondiente al pais de la sucursal
codigo_pais string 50 SI Codigo del pais de la sucursal
id_vendedor int 50 SI Identificador correspondiente al vendedor de la sucursal
id_cobrador int 50 NO Identificador correspondiente al cobrador de la sucursal
es_direccionCobro bool X SI Valida si es direccion de cobro
es_direccionDespacho bool X SI Valida si es direccion de despacho

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
    "success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

</Tab>

<Tab name = "API Modificar(PUT) "> PUT/users

EndPoint: https://www.apis.serpi.com.co/api/v1/Sucursales Headers

Header Descripción
secretkey Secretkey proporcionada al cliente para consumos de las APIs

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request 

{
    "id": 2317,
    "id_tercero": 1804,
    "codigo": 0,
    "referencia_sucursal": "",
    "descripcion": "PRUEBA CAMBIO",
    "direccion": "cra 22 #4-44",
    "direccion2": "",
    "telefono": "",
    "telefono2": "",
    "ext": null,
    "ext2": null,
    "movil": "",
    "id_ciudad": 5001,
    "id_departamento": 5,
    "id_pais": 1,
    "id_vendedor": 3418,
    "id_cobrador": null,
    "es_direccionCobro": false,
    "es_direccionDespacho": false
}

Campos del request

Campo Tipo de dato Longitud Requerido Descripción
id int 50 SI Corresponde al identificador de la sucursal
id_tercero int 50 SI Corresponde al identificador del tercero
nit_tercero int 50 SI Nit del tercero
codigo string 50 SI Codigo de la sucursal
referencia_sucursal string 50 SI Referencia de la sucursal
descripcion string 50 SI Descripcion de la sucursal
direccion string 50 SI Direccion de la sucursal
direccion2 string 50 NO Segunda direccion de la sucursal
telefono int 50 SI Telefono correspondiente a la sucursal
telefono2 int 50 NO Segundo telefono correspondiente a la sucursal
ext int 50 NO Extension de la sucursal
ext2 int 50 NO Extension de la sucursal
movil int 50 NO Celular de la sucursal
id_ciudad int 50 SI Identificador correspondiente a la ciudad de la sucursal
codigo_ciudad string 50 SI Codigo de la ciudad de la sucursal
id_departamento int 50 SI Identificador correspondiente al departamento de la sucursal
codigo_departamento string 50 SI Codigo del departamento de la sucursal
id_pais int 50 SI Identificador correspondiente al pais de la sucursal
codigo_pais string 50 SI Codigo del pais de la sucursal
id_vendedor int 50 SI Identificador correspondiente al vendedor de la sucursal
id_cobrador int 50 NO Identificador correspondiente al cobrador de la sucursal
es_direccionCobro bool X SI Valida si es direccion de cobro
es_direccionDespacho bool X SI Valida si es direccion de despacho

Authorization: 

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response 

{
"success": true
    	"code": 200,
    	"message": "registro modificado exitosamente"
}

{
    	"success": false,
    	"code": 400,
    	"errors": [
        		"El campo abreviatura es obligatorio"
    	],
    	"message": "Se presentaron errores al modificar el registro"
}




{
    	"success": false,
    	"code": 204,
    	"errors": null,
    	"message": "No se encontraron registros con el id xx"
}

</Tab> </Tabs>

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request 

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://localhost:44305/api/v1/Sucursales")
  .method("GET", body)
  .addHeader("secretkey", "{{secret key}}")
  .addHeader("Authorization", "Bearer{{token}}")
  .build();
Response response = client.newCall(request).execute();

</Tab>

<Tab name = "C#"> Request 

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Sucursales");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

</Tab>

<Tab name = "PHP"> Request 

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/Sucursales');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'secretkey' => '{{secret key}}',
  'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

</Tab>

</Tabs>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Documentos_Contables/Sucursales&oldid=568»