Documentacion Tecnica API ManagementV3

PL-Colab
Interoperabilidad Sistemas
de facturación externos
Especificación Técnica
Junio 2017
Control de Cambios
Versión Fecha Autor Descripción
1.0 15/09/2016 Manuel Segrera Creación del documento

1
1.1 20/12/2016 Lucenith Ramos Actualización de documento.
1.2 10/05/2017 Eneida Edinson Actualización de documento.
1.3 21/06/2017 Deimer Olea Actualización de documento.
1.4 10/07/2017 German Zabaleta Actualización de documento Coordenadas

de QR y CUFE.
1.5 23/11/2017 German Zabaleta Actualización de documento.

1. CONTENIDO
2. INTRODUCCIÓN .....................................................................................................................................................4
3. APROVISIONAMIENTO ...........................................................................................................................................4
4. SEGURIDAD ............................................................................................................................................................6
2
4.1 CREAR TOKEN DE SEGURIDAD .......................................................................................................................7
4.2 ACTUALIZAR TOKEN DE SEGURIDAD..............................................................................................................9
5. CONVENCIONES GENERALES ...............................................................................................................................12
5.1 MENÚ PRINCIPAL .........................................................................................................................................12
5.2 ACCEDER/CONSULTAR API ...........................................................................................................................13
5.2.1 SECCIÓN 1: BANDA VERTICAL PANEL IZQUIERDO..................................................................................14
5.2.2 SECCIÓN 2: NOMBRE Y DESCRIPCIÓN DEL MÉTODO O API ...................................................................14
5.2.3 SECCIÓN 3: PARÁMETROS .....................................................................................................................14
5.2.4 SECCIÓN 4: ENCABEZADO DE LA SOLICITUD ..........................................................................................15
5.2.5 SECCIÓN 5: CUERPO DE LA SOLICITUD ..................................................................................................15
5.2.6 SECCIÓN 6: EJEMPLOS DE CÓDIGO ........................................................................................................15
5.2.7 SECCIÓN 7: TRY IT / AUTENTICACIÓN EN LA API ...................................................................................16
5.2.8 SEND ......................................................................................................................................................16
6. AUTENTICACIÓN PORTAL API ..............................................................................................................................17
6.1 INICIAR SESIÓN ............................................................................................................................................18
6.2 SELECCIONAR EL PRODUCTO A UTILIZAR ....................................................................................................19
6.3 SELECCIONAR LA OPCIÓN DE AUTORIZACIÓN .............................................................................................19
6.3.1 IMPERSONACION ...................................................................................................................................23
6.3.2 IMPERSONACION CON TOKEN DE SEGURIDAD .....................................................................................26
7. API DISPONIBLES ..................................................................................................................................................29
7.1 RESUMEN DE PRODUCTO PARA LA EMISIÓN (PRODUCTOS/EMISIÓN) .......................................................29
7.2 DETALLE DE LAS API PARA EMISIÓN ............................................................................................................31
7.2.1 SUCURSALES ..........................................................................................................................................31
7.2.2 PROCESOS O CENTROS DE COSTOS .......................................................................................................43
7.2.3 FOLIOS O NUMERACIONES ....................................................................................................................54
7.2.4 COMPRADORES......................................................................................................................................62
7.2.5 EMISIÓN DE DOCUMENTOS ...................................................................................................................69

7.2.6 ACEPTACIÓN DE DOCUMENTOS ............................................................................................................75
7.2.7 CONSULTAS RELACIONADAS A UN DOCUMENTO .................................................................................79
3
2. INTRODUCCIÓN
Este documento describe las características del Portal API Management (servicio de Microsoft Azure ©) donde
Facture SAS tiene publicadas las API que se utilizan para la integración con la plataforma de facturación y
colaboración electrónica de PL-Colab.
La plataforma PL-Colab expone un API que permite a las aplicaciones realizar intercambio de información a través 4
de Web Services con interfaces definidas disponibles para los desarrolladores y las cuales serán descritas en el
presente documento.
Mediante el API Management se puede conocer la documentación de cada API, explorar las API, obtener códigos de
ejemplo en varias tecnologías y ejecutarlas obteniendo así un “cliente” directo.
Usando el portal para desarrolladores de autoservicio que le ofrece acceso a un catálogo de API, documentación y
ejemplos de código. Los desarrolladores pueden iniciar sesión usando identidades profesionales o de clientes
existentes, administrar claves de acceso, ver los informes de uso de API y efectuar llamadas de API sin necesidad de
escribir una línea de código mediante una consola.
Entre las ventajas de este mecanismo se encuentran:
• La documentación de la API se encuentra siempre disponible y actualizada ya que la fuente de la misma es

el API en sí que se encuentra publicado.
• Fácil comprensión de las API´s
• Seguridad basada en un esquema de JSON Web Token (JWT) y filtrado de direcciones IP.
• Uso de almacenamiento en caché lo que permite respuestas a una mejor escala y latencia
• Simplificar y optimizar las solicitudes y las respuestas con directivas de transformación.
3. APROVISIONAMIENTO
Para acceder al API Management el cliente debe registrarse en la dirección de API Management específica:
• https://plcolab-api-portal-sandbox.facture.co : Portal para clientes que se encuentran realizando pruebas

de integración.
• https://plcolabbeta.portal.azure-api.net: Portal para clientes que ya se encuentran en el proceso pre
productivo.
Mediante el proceso de registro el cliente ingresa los datos correspondientes, indicando el usuario y contraseña que
utilizará en el portal.
1. Hacer clic en Regístrese ahora.
2. Ingresar la información solicitada en el formulario.
3. Hacer clic en Registrarse.

Una vez completado el registro; los datos son enviados a Facture para aprobación del registro y se regresa una
notificación por correo electrónico indicando que el proceso está realizado. A continuación, un ejemplo de la
notificación:
A partir de éste momento el cliente está en capacidad de ingresar al portal.
4. SEGURIDAD
El sistema siempre realiza control de acceso teniendo en cuenta el usuario y contraseña suministrado por facture, y
a partir de aquí, se genera un TOKEN de seguridad por cada sesión. El estándar para este tipo de autenticación es
utilizar JSON Web Tokens (JWT); el formato JSON es indistinto al lenguaje, y podemos utilizar el que queramos
(Node.js, Python, Ruby, PHP, .NET, Java...).
Luego que el servidor de ok, de forma inmediata retorna un token cómo respuesta, dicho token debe ser enviado
en las siguientes peticiones para poder acceder a los recursos y las API expuestas para la integración.
En cada petición nuestro servidor valida el token proporcionado por el usuario y, si es correcto, podrá acceder
nuestras API, si no, se denegará la petición.
Este mecanismo añade más seguridad. Al no utilizar cookies para almacenar la información del usuario, se puede
evitar ataques CSRF (Cross-Site Request Forgery) que manipulen la sesión que se envía al back-end.
Adicionalmente es posible hacer que el token expire después de un tiempo lo que le añade una capa extra de
seguridad. En dicho caso sería necesario renovar el token para continuar.
4.1 CREAR TOKEN DE SEGURIDAD
seleccionar la opción de Security
El siguiente paso consiste en crear el token de seguridad.

7
Visualizamos el API Crear Token de Seguridad, y damos clic en el botón Try it.
En el cuerpo de la solicitud, se encuentra el siguiente formulario:

{tenantId: '{{tenantId hijo}}', token: '{{token de seguridad}}'}. Para hacer uso del API es necesario estar
autenticados.
• TenantId (t) = ID del contrato hijo.
• Token (s) = token de seguridad del contrato hijo generado por el ERP.
Para registrar la información en cada uno de los parámetros se reemplaza el nombre del parámetro y las llaves {{ }}
dejando solamente la información contenida en comillas simples ' '
Ejemplo:
Una vez reemplazados los parámetros por los valores apropiados, se puede notar que se actualiza el HTTP request
de la petición:
Luego se envía la petición mediante el uso del botón “Send”.
A continuación, se muestra la respuesta y su contenido. Si la solicitud es exitosa, el sistema responde: (200 OK), y
genera un token de autenticación, que permitirá al usuario conectarse para realizar acciones al contrato padre sobre
sus contratos hijos.
4.2 ACTUALIZAR TOKEN DE SEGURIDAD

seleccionar la opción de Security
El siguiente paso consiste en Actualizar un token de seguridad.

Visualizamos el API Actualizar Token de Seguridad, y damos clic en el botón Try it.
10

{tenantId: '{{tenantId hijo}}', token: '{{token de seguridad}}'}. Para hacer uso del API es necesario estar
autenticados.
• TenantId (t) = ID del contrato hijo.
• Token (s) = Nuevo token de seguridad del contrato hijo generado por el ERP.
Ejemplo:
de la petición:
11
actualiza el token de autenticación, que permitirá al usuario conectarse para realizar acciones al contrato padre sobre
sus contratos hijos.
5. CONVENCIONES GENERALES
Las siguientes son las convenciones generales manejadas en el Portal API, esta es una plataforma de administración
de API que permite conectarse con toda seguridad a los servicios back-end con independencia del lenguaje de
programación en el cual este desarrollado su sistema de información.
12
5.1 MENÚ PRINCIPAL

En la parte superior se muestran cuatro menús principales como se observa en la imagen siguiente:
1. APIS: Esta sección muestra el listado de las API y los parámetros de cada una identificando el tipo de dato
del parámetro, la descripción y la obligatoriedad.
2. PRODUCTS: Esta sección muestra las dos API que expone PL-Colab, las cuales se clasifican acorde a la
funcionalidad de emisión de facturación electrónica y a la recepción de documentos electrónicos.
3. APPLICATIONS: Esta sección no está disponible.
4. ISSUES: Por medio de ésta sección el cliente puede “notificar problemas”.

5.2 ACCEDER/CONSULTAR API
Cada vez que se accede a una API se encuentra la estructura siguiente, la cual podemos describir como sigue:
13
5.2.1 SECCIÓN 1: BANDA VERTICAL PANEL IZQUIERDO
En esta barra se pueden identificar cada uno de los métodos disponibles
para la manipulación y/o interacción con el sistema:
• Blanco: método actualmente seleccionado PUT.

• Naranja: método POST.
14
• Rojo: método DELETE.
• Verde: métodos GET.
GET: Utilizado para consultar y leer recursos.
POST: Utilizado para crear recursos.
PUT: Utilizado para editar recursos.
DELETE: Utilizado para eliminar recursos.
5.2.2 SECCIÓN 2: NOMBRE Y DESCRIPCIÓN DEL MÉTODO O API

Corresponde al nombre de la API y la URL con la que se expone el método.
5.2.3 SECCIÓN 3: PARÁMETROS

El API Management muestra los parámetros, tipo de dato, descripción y obligatoriedad de los mismos.
5.2.4 SECCIÓN 4: ENCABEZADO DE LA SOLICITUD
El API Management muestra el encabezado con una descripción de lo que realizará el API.
15
5.2.5 SECCIÓN 5: CUERPO DE LA SOLICITUD

El cuerpo de la solicitud muestra cómo debe realizarse la solicitud en formato JSON o XML del request de la solicitud.
Estos ejemplos ayudarán a preparar el set de datos a enviar con la solicitud.
5.2.6 SECCIÓN 6: EJEMPLOS DE CÓDIGO

Muestra el ejemplo del código que el desarrollador debe insertar en su aplicación para consumir las diferentes API
y sus métodos. Los ejemplos se encuentran disponibles en Curl, C#, Java, JavaScript, ObjC, PHP, Phyton y Ruby.
5.2.7 SECCIÓN 7: TRY IT / AUTENTICACIÓN EN LA API
Siempre que vaya a utilizar o consumir una API debe incluir la autenticación necesaria para que Facture le permita
su uso. Esta autenticación se refleja en un HEADER y es el Token de seguridad generado cuando se efectúa la
autenticación. Se siguen los siguientes pasos:
1. Hacer clic en Add header

16
2. Digitar la palabra Authorization como nombre del HEADER que se va a adicionar.
3. Digitar la palabra Bearer y el Token generado en la autenticación en la caja de texto al frente del
HEADER, como se muestra a continuación
Ejemplo:
Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJxc2giOiIyMTFmOWI3OC1mYWYzLTQ3OTUtYWIxMi1hNzkwM
DE3OGJkNTYiLCJpYXQiOiIxNDk3MzA3OTAwIiwic3ViIjoiMGQyOWJkNzgtMGYxMi00NjhhLWJiY2MtYTY5ZTA
xN2QyZGZmIiwibmFtZSI6IjkwMDM5y7iWMSIsInVzciI6IjkwMDM5OTc0MSIsIjNpZCI6IjkwMDM5OTc0MSIsI
jNuYW1lIjoiRkFDVFVSRSBTLkEuUy4iLCJjY29kIjoiQ08iLCJyZWciOiIxMyIsImNpdHkiOiIxMzAwMSIsImFkZHIi
OiJDYWxsZSAyNiAjMjEtMTY0IiwidGF4IjoiUkVHQ09NIiwiaXNzIjoiUkQwMDE1NUQ0MzgzMEYi98ubWHAi
OjE0OTczOTQzMDAsIm5iZiI6MTQ5NzMwNzYwMH0.lDDIwmOWnDP9ieK1c9VfgBq5EpXLTOVE19i6cQtj1z
5.2.8 SEND
Presione el botón “Send” para consumir el API con los parámetros que se han digitado previamente.
Una vez se lance la petición de consumo, en la página se muestran dos nuevas secciones:
1. Sección 6: Corresponde a el código de respuesta de la petición. Si este es 200-OK quiere decir que la petición
se realizó exitosamente; en caso contrario se mostrará el código y descripción del error respectivo.
*Nota: A continuación, se mencionan algunos códigos

de estado que pueden aparecer posterior a presionar 17
SEND:
1- Los códigos de estado 2XX (Correcto)

Ej.: 200 (Ok)
2- Los códigos de estado 4XX (Error de solicitud)
Ej.: 401 (Unauthorized)
2. Sección 7: Corresponde a un resumen con detalles del error, fecha, etc.
6. AUTENTICACIÓN PORTAL API

El primer paso que se debe realizar es autenticarse en el Portal para poder acceder a la documentación y todas las
funcionalidades y características descritas en el documento.
Para la autenticación en el Portal, se utiliza el usuario y contraseña con el que se registró, así como el número de
Contrato o TenantID suministrado por Facture durante el proceso de registro en la plataforma.
6.1 INICIAR SESIÓN
El Portal API se encuentra localizado en la URL: https://plcolab-api-portal-sandbox.facture.co
18
Una vez iniciada sesión en el sistema, se tiene disponibilidad de las API. En este momento es posible generar un API
Key (token de seguridad) para posteriormente hacer uso de los métodos que la requieren.
6.2 SELECCIONAR EL PRODUCTO A UTILIZAR
En el mundo de la facturación electrónica, existen dos aspectos principales, que a la vez son roles que puede cumplir
un cliente en la plataforma: Emisor y Receptor. PL-Colab organiza sus funcionalidades en dos categorías para cada 19
uno de dichos aspectos:
• Emisión: Permite realizar la emisión de documentos electrónicos, así como el mantenimiento de sucursales,
centros de costo (procesos), numeraciones (folios), procesos de aceptación/rechazo de los documentos y
consultas a diferentes niveles.
• Recepción: Permite realizar los procesos de Recepción y Envío de documentos entre Plataformas de
Colaboración Electrónica. Funcionalidad conocida como un "Inbox".
6.3 SELECCIONAR LA OPCIÓN DE AUTORIZACIÓN

El siguiente paso consiste en obtener el token, haciendo login con el usuario y clave asignada para el contrato
(Tenant).
Visualizamos el API de autenticación (Login), y damos clic en el botón Try it.
20

{u:'{{username}}', p:'{{password}}', t:'{{tenantId}}'}
• username(u) = Usuario registrado.
• Password(p) = Contraseña de usuario.
• TenantId(t) = ID del contrato con el que se requiere autenticar
Ejemplo:
21
de la petición:

genera un token de autorización, que permitirá al usuario conectarse para realizar posteriores peticiones, dicho token
22
tendrá una caducidad de 24 horas, contados a partir de que éste sea generado.
Nota: El “accessToken” se debe copiar sin las comillas (“ ”), es de vital importancia copiar y guardar el
Token de seguridad porque será utilizado de aquí en adelante cuando se vaya a interactuar con las
distintas API´s.
6.3.1 IMPERSONACION
Seleccionar la opción de autorización
El siguiente paso consiste en obtener el token, haciendo login con contratos clientes.
23

En el cuerpo de la solicitud, se encuentra el siguiente formulario: {u:'{{username}}', p:'{{password}}',
t:'{{tenantId}}'}, en el cual se debe adicionar el siguiente campo i:'{{tenantId}}'
• TenantId(t) = ID del contrato padre. (Opcional)
24
• TenantId(i)= ID del contrato con el que se requiere autenticar.
Ejemplo:
25
de la petición como se puede visualizar en la imagen:

26
Nota: El “accessToken” se debe copiar sin las comillas (“ ”), es de vital importancia copiar y guardar el Token de
seguridad porque será utilizado de aquí en adelante cuando se vaya a interactuar con las distintas API´s.
6.3.2 IMPERSONACION CON TOKEN DE SEGURIDAD

seleccionar la opción de autorización
El siguiente paso consiste en obtener el token, haciendo login con contratos clientes.

27
En el cuerpo de la solicitud, se encuentra el siguiente formulario: {u:'{{username}}', p:'{{password}}',

t:'{{tenantId}}'}, en el cual se debe adicionar el siguiente campo S:'{{Authorizationsoftware}}'
• TenantId(t) = ID del contrato padre. (Opcional)
• Authorization software (s)= token de seguridad del contrato hijo que envía el ERP a Facture. Este debe ser
único para todos los contratos y debe tener una longitud de 36 caracteres alfanuméricos.
Ejemplo:
28
de la petición:
29
Nota: El “accessToken” se debe copiar sin las comillas (“ ”), es de vital importancia copiar y guardar el Token de
seguridad porque será utilizado de aquí en adelante cuando se vaya a interactuar con las distintas API´s.
7. API DISPONIBLES
PL-Colab expone las API necesarias para lograr la integración entre la plataforma de colaboración electrónica y el
sistema facturador externo.
Como mensionamos anteriormente las funcionalidades están agrupadas en dos grandes categorías:
• Emisión: Permite realizar la emisión de documentos electrónicos, se permite el mantenimiento de

sucursales, procesos o centros de costo, folios o numeración, procesos de aceptación/rechazo de los
documentos y consultas a diferentes niveles.
• Recepción: Permite realizar los procesos de Recepción y Envío de documentos entre Plataformas de
Colaboración Electrónica. Funcionalidad conocida como un "Inbox".
7.1 RESUMEN DE PRODUCTO PARA LA EMISIÓN

(PRODUCTOS/EMISIÓN)
A continuación, se muestra un resumen de la API disponibles dentro del contexto de emisión de documentos.
AUTORIZACIÓN (Log y generación de token)

Por medio de éste API se le permite al usuario la conexión al API Management y la generación del TOKEN que se
utilizará para validar la seguridad durante un periodo de tiempo determinado. Cabe anotar que el log en el API
Management es solo para el rastreo de peticiones enviadas.
SUCURSALES (Mantenimiento de Sucursales)

30
Mediante éste API se le permite al sistema facturador realizar el mantenimiento de las sucursales, en caso que la
empresa tenga varias. Las sucursales son importantes para PL-COLAB porque se deben determinar permisos a
documentos, roles, etc.
PROCESOS (Mantenimiento Centros de Costo)
Mediante éste API se le permite al sistema facturador realizar el mantenimiento de los centros de costo, en caso que
la empresa tenga varios. Los centros de costo, son divisiones dentro de las sucursales, que pueden llegar a emitir
con consecutivos de factura diferente.
COMPRADORES (Mantenimiento de Compradores)
Mediante esta API se le permite al sistema facturador realizar el mantenimiento de los compradores en la plataforma
PL-Colab. Cabe anotar que PL-Colab no necesita guardar la información de los compradores o sincronizar ésta
información con el sistema facturador de la empresa. Esta es una opción completamente configurable y tiene alcance
hasta donde lo acuerden Facture y la empresa.
DOCUMENTOS (Consultas de documentos)
Mediante esta API se exponen las consultas necesarias para que el sistema facturador recolecte la información
relevante de la facturación electrónica y pueda realizar trazabilidad dentro de su propio sistema. Se puede consultar
el envío a la DIAN, el estado de un documento específico, los archivos adjuntos de un documento, binarios XML y
listas de documentos.
FOLIOS (Mantenimiento Numeraciones de la DIAN)
Mediante esta API se exponen los servicios que le permiten a PL-Colab obtener la información de las numeraciones
autorizada por la DIAN al OFE (Obligado a Facturar Electrónicamente) para la facturación electrónica de la empresa.
Siempre debe ser enviada por el sistema que genera las facturas, el número de la misma. PL-Colab hará las
validaciones de consistencia de los datos enviados, para garantizar que se envían número validos de la resolución
autorizada.
El envío de los consecutivos de facturas, no debe ser cronológico, pero si debe ser consistente en cuando a fechas,
es decir, es posible enviar el número de factura 11 antes de la 10, pero al enviar la 10, su fecha de emisión debe ser
consistente respecto a la 10 (menor o igual)
DOCUMENTOS (Emisión de documentos)

Mediante esta API se expone todo lo concerniente a la emisión de documentos (Ej.: Factura electrónica, Nota crédito,
Nota débito) y a las acciones efectuadas por parte del cliente tras recibir el documento electrónico, aceptarlo,
rechazarlo o acusar su recibo.
31
7.2 DETALLE DE LAS API PARA EMISIÓN

7.2.1 SUCURSALES
PL-Colab permite la creación de sucursales teniendo en cuenta que una empresa puede tener múltiples sedes en
todo el país.
Paso 1: Seleccione PRODUCTS y el producto Emisión: [plcolab-pre] Emisión.
Paso 2: Seleccione el API Branches

EL API Branches (Sucursales) expone los siguientes métodos:
• Actualizar Sucursal
• Crear Sucursal
• Eliminar Sucursal
• Listar Sucursales
• Listar Sucursal por Código 32
• Listar sucursales por referencia
7.2.1.1 CREAR/EDITAR SUCURSALES
Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo (Productos/Emisión/Sucursales), se escoge el

método “Crear Sucursal”.
El API Management muestra los parámetros, tipo de dato, descripción y obligatoriedad de los mismos; ejemplo en
formato JSON y XML del request de la solicitud y ejemplos de código.
Para poder acceder, crear, probar la API, debe utilizar el botón “Try it” señalado en la gráfica anterior.
Lo primero que debe realizarse es adicionar el header para autenticarse tal y como se explica en el capítulo “5.2.7
Sección 7: Try it / Autenticación en la API”
Recuerde que hay que logearse en la API
para poder consumirla:
1. Hacer clic en Add header

2. Digitar la palabra
Authorization como nombre
del HEADER que se va a
adicionar.
3. Digitar la palabra Bearer y el
Token generado en la
autenticación en la caja de
texto al frente del HEADER,
como se muestra a
continuación
33
Ejemplo:
Bearer
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ
9.eyJxc2giOiIyMTFmOWI3OC1mYWYzL
TQ3OTUtYWIxMi1hNzkwMDE3OGJkN
………….
1. En el cuerpo de la solicitud, se encuentra el siguiente formulario:

{
"name": "Foo",
"code": "Some Code",
"addressLine": "some address Line",
"addressLine2": "some address Line2",
"cityCode": "some city",
"countryCode": "some country",
"regionCode": "some region",
"postalCode": "some postal code",
"neighborhood": "some neighborhood"
}
dónde se debe diligenciar la información de la sucursal a registrar, luego entonces se da clic en el
botón Send.
34
Defínase los campos anteriores como:

{
"name": "Nombre de la sucursal",
"code": "Código de la sucursal",
“ExternalReference”: "Referencia de la sucursal",
"addressLine": "Dirección principal",
"addressLine2": " Dirección secundaria",
"cityCode": "Ciudad",
"countryCode": "Código del país",
"regionCode": "some region",
"postalCode": "Código postal",
"neighborhood": "Barrio"
}
Para editar, se debe dejar las comillas “”
2. Si la solicitud es exitosa, el sistema responde: (200 OK)
35
4. Para actualizar una sucursal se debe realizar lo siguiente:

1. Clic en Actualizar Sucursal.
2. Clic en Try it.
36
3. Digitar el código de la sucursal a actualizar en branchCode.

4. Hacer clic en Add header, digitar Authorization y pegar el token anteponiendo la palabra Bearer.
5. En el cuerpo de la solicitud digitar la información con los datos actualizados.
6. Hacer clic en Send.
7. Si la solicitud es exitosa, el sistema responde: (200 OK).
37
7.2.1.2 LISTAR SUCURSALES
PL-Colab permite la creación de sucursales las cuales pueden listarse por medio de API´s como se describen en los
siguientes puntos:
1. Hacer clic en Listar sucursales. 38
2. Clic Try it.
3. Digitar la página y el tamaño en pageIndex y pageSize.


7. Si la solicitud es exitosa, el sistema responde: (200 OK).
39
4. Para listar sucursales por código realizar los siguientes pasos:

1. Hacer clic en Listar sucursales por código.
2. Clic en Try it.
3. Digitar el código de la sucursal en branchCode.

40

6. Si la solicitud es exitosa, el sistema responde (200 OK)
7.2.1.3 ELIMINAR SUCURSALES
PL-Colab permite eliminar sucursales que se encuentran registradas en el sistema como se describen en los
siguientes puntos:
1. Hacer clic en Eliminar Sucursal.

2. Clic en Try it. 41
3. Digitar el código de la sucursal en branchCode.

4. Realizar clic en Add header, digitar Authorization y pegar el token anteponiendo la palabra
Bearer.
42

7.2.2 PROCESOS O CENTROS DE COSTOS
PL-Colab ha denominado Procesos a la clasificación adicional que puede realizarse en una sucursal, para algunas
empresas éstos son los Centros de Costos.
43
Paso 2: Seleccione el API Process

EL API Process (Proceso) expone los siguientes métodos:
• Actualizar Proceso
• Crear Proceso
• Eliminar Proceso
• Listar Proceso
• Listar proceso por Código
• Listar proceso por referencia 44
7.2.2.1 CREAR/EDITAR PROCESOS O CENTROS DE COSTOS

Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo (Productos/Emisión/Procesos), se escoge el
método “Crear proceso”.
formato JSON y XML del request de la solicitud y ejemplos de código
1. Hacer Clic en Crear proceso.

2. Clic en Try it.
{
"description": "some description",
"name": "some name",
"code": "some code"
45
"externalReference":"some externalReference "
}

"description": "descripción de proceso",
"name": "Nombre del proceso",
"code": "Código del proceso",
"externalReference":"referencia externa del proceso"
5. Hacemos clic en Send.
46
8. Hacer clic en Actualizar Procesos.

9. Clic en Try it.
10. Digitar el código del proceso en processCode.

47

5. Para Listar los Procesos realizar los siguientes pasos:
1. Hacer clic en Listar Procesos.

2. Clic en Try it.
48


49
7.2.2.2 LISTAR PROCESOS O CENTROS DE COSTOS

1. Hacer clic en listar procesos por código.

2. Clic en Try it.
3. Digitar el código de la sucursal en processCode.
50
51
6. Para Listar procesos por referencia realizar los siguientes pasos:

1. Hacer clic en Listar procesos por referencia.
2. Clic en Try it.
3. Digitar la referencia externa de la sucursal en ProcessReference.
4. Hacer clic en Add header, digitar Authorization y pegar el Token anteponiendo la palabra Bearer.
52

7.2.2.3 ELIMINAR PROCESOS O CENTROS DE COSTOS
1. Hacer clic en Eliminar proceso. 53

2. Clic en Try it.
3. Digitar la referencia externa de la sucursal en ProcessCode.


54
7.2.3 FOLIOS O NUMERACIONES

El termino Folios está asociado a la numeración que le ha sido autorizada al Cliente por la DIAN y que ha sido
expedida en la resolución de Facturación electrónica autorizada para tal fin. El proceso de registro de folios puede
llevarse a cabo desde dos puntos:
• El cliente sea quien administre la numeración de facturas entregadas por la DIAN.

• FACTURE como su proveedor tecnológico sea quien lo administre.
Adicional FACTURE realiza validaciones de control sobre la numeración de las facturas.

55
Paso 2: Seleccione el API Folios
EL API Folios (Numeración) expone los siguientes métodos:
• Actualizar Folio
• Guardar Folio
• Listar Folio
7.2.3.1 CREAR/EDITAR FOLIOS O NUMERACIÓN
1. Hacer Clic en Folios.

2. Clic en Guardar folio.
4. Digitar la referencia externa de la sucursal en ProcessCode.

{
"branchCodes":[],
"processCodes":[],
"documentTypeCode": "some_documentType",
57
"approbationNumber":"some_number",
"approbationStartingDate": "some date start aprobation",
"approbationEndingDate": "some date expiration",
"prefix":"prefix_numeration",
"startingAt":1,
"endingAt":1,
"isAutomatic":true,
"keyControl":"586e84c2-080b-4a68-84ee-868ae82a82e6"
}
Dónde se debe diligenciar la información del folio a registrar.

{
"branchCodes":[Código de la sucursal],
"processCodes":[Código del proceso],
"documentTypeCode": "código del tipo de documento",
"approbationNumber":"Numero de aprobación",
"approbationStartingDate": "Fecha de aprobación",
"approbationEndingDate": "Fecha de vencimiento",
"prefix":"prefijo de la numeración",
"startingAt": rango inicial de la numeración,
"endingAt": rango final de la numeración,
"isAutomatic":estado true/false,
"keyControl":"llave de control"
}
58
7.2.3.2 ACTUALIZAR FOLIOS

expedida en la resolución de Facturación electrónica autorizada para tal fin.
1. Hacer clic en Actualizar folio.

2. Clic en Try it.
59
3. Digitar el ID del folio registrado en ID el cual se encuentra al listar los folios.

4. Hacer clic en Add header, digitar Authorization y pegar el Token anteponiendo la palabra Bearer.
5. Hacer clic en Send. Si la solicitud es exitosa, el sistema responde (200 OK) y actualiza el folio.
60
7.2.3.3 LISTAR FOLIOS

expedida en la resolución de Facturación electrónica autorizada para tal fin.
1. Hacer clic en Listar folio.

2. Clic en Try it.
61
5. Hacemos clic en send. Si la solicitud es exitosa, el sistema responde (200 OK) y lista los folios.
7.2.4 COMPRADORES
El término Compradores en PL-Colab se conoce como Customers y son todos aquellos clientes de la empresa
facturadora o adquirientes como están relacionados en la documentación de la DIAN.
Existen Compradores como persona jurídica y como persona natural. 62
7.2.4.1 CREAR/EDITAR COMPRADORES
1. Hacer clic en crear comprador compañía.

2. Clic en Try it.
63

{
"identificationNumber": "Some_identification_number",
"verificationDigit":3,
"IdentificationType":"NIT",
"companyName":"Some Name",
"tradename": "Some trade name",
"taxCategory": "REGCOM",
"principalPhone": 3016055490,
"email": "noreply@fakedomain.com",
"externalReference": "Some_ExternalReference",
"addressLine": "Some Address",
"addressLine2": "Some Address 2",
"cityCode": "13001",
"countryCode": "CO",
"regionCode": "13",
"postalCode": "130003",
"neighborhood": "Some Neighborhood",
"businessSector": "Some_Business_Sector",
"invoiceQuantity": "SOMETHING",
“PrincipalPhone_Number”:3205011120
}
5. Digitar la información solicitada en el formulario y hacer clic en Send. Si la solicitud es exitosa, el
sistema responde (200 OK).
64
4. Para registrar una persona como comprador realizar los siguientes pasos:
1. Hacer clic en crear comprador persona.
2. Clic en Try it.
65
3. Hacer clic en Add header, digitar Authorization y pegar el token anteponiendo la palabra Bearer
{
"identificationType": "CC",
"identificationNumber": "Some_Identification",
"taxCategory": "REGCOM",
66
"firstName": "Some Name",
"middleName": "Some Middlenama",
"firstSurName": "Some Name",
"secondSurName": "Some Second SurName",
"email": "noreply@fakedomain.com",
"principalPhone_Number": 1234567890,
"addressLine": "Some Address Line",
"addressLine2": "Some Address Line 2",
"neighborhood": "Some Neighborhood",
"countryCode": "CO",
"regionCode": "13",
"cityCode": "13001",
"postalCode": "130003",
"externalReference": "Some_External_Reference",
}
5. Digitar la información solicitada y hacer clic en send. Si la solicitud es exitosa, el sistema responde
(200 OK)
7.2.4.2 LISTAR COMPRADORES
El término Compradores en PL-Colab se conoce como Customers y son todos aquellos clientes de la empresa
facturadora o adquirientes como están relacionados en la documentación de la DIAN.
1. Hacer clic en compradores por referencia.

3. Digitar la referencia externa de un comprador registrado en buyerReference.

5. Hacer clic en send. Si la solicitud es exitosa, el sistema responde (200 OK) y muestra el
comprador.
68
7.2.5 EMISIÓN DE DOCUMENTOS
Desde la interface se realiza la emisión de documentos tales como: factura, nota crédito, nota debito atreves de la
API emitir documento
69
Paso 2: Seleccione el API Issue

7.2.5.1 EMITIR DOCUMENTOS
Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo (Products/Emision/Issue ), se escoge el método
“Emitir documento”.
70
1. Se visualiza el API de Emitir 1- documento, y se hace clic en el botón Try it.
2. A través de esta API es posible emitir una factura de venta. Para ello, se debe editar el XML que se
encuentra en el cuerpo de la solicitud, con sus respectivos datos a facturar, adicionalmente, se
envía el tipo de formato como Query Parameter, y, por último, como parámetro de cabecera se
envía:
• X-REF-BRANCH (referencia externa de la sucursal)
• X-REF-PROCESS (referencia externa del proceso)
• Coordenadas de QR y CUFE:
• X-QR-XPOSITION (Ubicación de QR en X)
• X-QR-YPOSITION (Ubicación de QR en Y)
• X-CUFE-XPOSITION (Ubicación de CUFE en X)
• X-CUFE-YPOSITION (Ubicación de CUFE en Y)
• X-CURRENCY (Ubicación del COP)
Nota: El número de la factura debe ser el nombre del PDF.
• X-REF-DOCUMENTTYPE (referencia externa del tipo documento: FACTURA-UBL, NC-UBL o ND-
UBL), y el token de autorización (anteponiendo al token, la palabra “Bearer”); Para ejecutar la
petición, hacer clic en el botón Send.
71
“XML de FACTURA, ubicado en el cuerpo de la solicitud”
<fe:Invoice>
<cbc:UBLVersionID></cbc:UBLVersionID>
<cbc:ProfileID></cbc:ProfileID>
<cbc:ID></cbc:ID>
<cbc:IssueDate></cbc:IssueDate>
<cbc:IssueTime></cbc:IssueTime>
<cbc:InvoiceTypeCode></cbc:InvoiceTypeCode>
<cbc:Note></cbc:Note>
<cbc:DocumentCurrencyCode></cbc:DocumentCurrencyCode>
<fe:AccountingSupplierParty>
<cbc:AdditionalAccountID></cbc:AdditionalAccountID>
<fe:Party>
<cac:PartyIdentification>
<cbc:ID></cbc:ID>
</cac:PartyIdentification>
<cac:PartyName>
<cbc:Name></cbc:Name>
</cac:PartyName>
<fe:PhysicalLocation>
72
<fe:Address>
<cbc:Department></cbc:Department>
<cbc:CitySubdivisionName></cbc:CitySubdivisionName>
<cbc:CityName></cbc:CityName>
<cac:AddressLine>
<cbc:Line>
<cbc:Line>
</cac:AddressLine>
<cac:Country>
<cbc:IdentificationCode></cbc:IdentificationCode>
</cac:Country>
</fe:Address>
</fe:PhysicalLocation>
<fe:PartyTaxScheme>
<cbc:TaxLevelCode></cbc:TaxLevelCode>
<cac:TaxScheme/>
</fe:PartyTaxScheme>
<fe:Person>
<cbc:FirstName> </cbc:FirstName>
<cbc:FamilyName></cbc:FamilyName>
<cbc:MiddleName></cbc:MiddleName>
</fe:Person>
</fe:Party>
</fe:AccountingSupplierParty>
<fe:AccountingCustomerParty>
<cbc:AdditionalAccountID>2</cbc:AdditionalAccountID>
<fe:Party>
<cac:PartyIdentification>
<cbc:ID></cbc:ID>
</cac:PartyIdentification>
<cac:PartyName>
</cac:PartyName>
<fe:PhysicalLocation>
<fe:Address>
<cbc:Department></cbc:Department>
<cbc:CitySubdivisionName></cbc:CitySubdivisionName>
<cbc:CityName></cbc:CityName>
<cac:AddressLine>
<cbc:Line>
<cbc:Line>
</cac:AddressLine>
<cac:Country>
<cbc:IdentificationCode></cbc:IdentificationCode>
73
</cac:Country>
</fe:Address>
</fe:PhysicalLocation>
<fe:PartyTaxScheme>
<cbc:TaxLevelCode></cbc:TaxLevelCode>
<cac:TaxScheme/>
</fe:PartyTaxScheme>
<fe:Person>
<cbc:FirstName> </cbc:FirstName>
<cbc:FamilyName></cbc:FamilyName>
<cbc:MiddleName></cbc:MiddleName>
</fe:Person>
</fe:Party>
</fe:AccountingCustomerParty>
<fe:TaxTotal>
<cbc:TaxAmount currencyID="COP"></cbc:TaxAmount>
<cbc:TaxEvidenceIndicator></cbc:TaxEvidenceIndicator>
<fe:TaxSubtotal>
<cbc:TaxableAmount currencyID="COP"></cbc:TaxableAmount>
<cbc:Percent></cbc:Percent>
<cac:TaxCategory>
<cac:TaxScheme>
<cbc:ID></cbc:ID>
</cac:TaxScheme>
</cac:TaxCategory>
</fe:TaxSubtotal>
</fe:TaxTotal>
<fe:LegalMonetaryTotal>
<cbc:LineExtensionAmount currencyID="COP"></cbc:LineExtensionAmount>
<cbc:TaxExclusiveAmount currencyID="COP"></cbc:TaxExclusiveAmount>
<cbc:AllowanceTotalAmount currencyID="COP"></cbc:AllowanceTotalAmount>
<cbc:ChargeTotalAmount currencyID="COP"></cbc:ChargeTotalAmount>
<cbc:PayableAmount currencyID="COP"></cbc:PayableAmount>
</fe:LegalMonetaryTotal>
<fe:InvoiceLine>
<cbc:ID></cbc:ID>
<cbc:InvoicedQuantity></cbc:InvoicedQuantity>
<cbc:LineExtensionAmount currencyID="COP"></cbc:LineExtensionAmount>
<fe:Item>
<cbc:Description></cbc:Description>
</fe:Item>
<fe:Price>
<cbc:PriceAmount currencyID="COP"></cbc:PriceAmount>
</fe:Price>
<cac:TaxTotal>
74
<cbc:TaxEvidenceIndicator></cbc:TaxEvidenceIndicator>
<cac:TaxSubtotal>
<cbc:TaxableAmount currencyID="COP"></cbc:TaxableAmount>
<cbc:Percent></cbc:Percent>
<cac:TaxCategory>
<cac:TaxScheme>
<cbc:ID></cbc:ID>
</cac:TaxScheme>
</cac:TaxCategory>
</cac:TaxSubtotal>
</cac:TaxTotal>
</fe:InvoiceLine>
</fe:Invoice>
3. Una vez realizada la emisión, el sistema debe mostrar 200 OK como respuesta exitosa.
Adicionalmente, cuando se emita la factura, como parte de la respuesta se recibe un requestId
que registra la trazabilidad de la emisión, una propiedad llamada UUID que corresponde al CUFE
de la factura, el LDF que es el identificador único del documento, y la URL del visor público, para
visualizar el .PDF de la factura.
7.2.6 ACEPTACIÓN DE DOCUMENTOS
Uno de los requisitos para que la factura constituya título valor, es la aceptación por parte del comprador.
75
7.2.6.1 ACEPTACIÓN DE DOCUMENTO: ACCIÓN ACEPTAR
Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo (Productos/Emisión/Emisión), se escoge el
método “Emitir documento”.
1. Hacer clic en Emitir 4 – Aceptar documento.

2. Clic en Try it.
3. Digitar el LDF del documento registrado.

76
5. Hacemos clic en send. Si la solicitud es exitosa, el sistema responde (200 OK).

7.2.6.2 ACEPTACIÓN DE DOCUMENTO: ACCIÓN RECHAZAR
Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo ( Products/Emision/Issue ), se escoge el método
“Emitir documento”.
77
1. Hacer clic en Emitir 5- Rechazar documento.

2. Clic en Try it.
3. Digitar el LDF de un documento que no esté en estado Aceptado.
78
5. Hacemos clic en Send. Si la solicitud es exitosa, el sistema responde (200 OK).

7.2.7 CONSULTAS RELACIONADAS A UN DOCUMENTO
PL-Colab permite consultar los documentos que se encuentre en diferentes estados.
7.2.7.1 CONSULTAR ESTADO DEL DOCUMENTO

Después de realizar el paso 1 y 2 descrito en el inicio de éste capítulo (Productos/Emisión/Emisión), se escoge el
método “Emitir documento”. 79
1. Hacer clic en Emitir 2-consulta estado.

2. Clic en Try it.
3. Digitar la página y el tamaño en pageIndex y pageSize y requesId.

5. Hacer clic en send. Si la solicitud es exitosa, el sistema responde (200 OK).
80
4. Para consultar aceptación y rechazo se realiza lo siguiente:

1. Hacer clic en Emitir 3 –consultar Aceptación/Rechazo.
2. Clic en Try it.
3. Digitar el LDF del documento emitido.

4. Hacer clic en Add header, digitar Authorization y pegarel token anteponiendo la palabra Bearer
81
5. Hacer clic en send. Si la solicitud es exitosa, el sistema responde (200 OK.
7.2.7.2 CONSULTAR DOCUMENTOS RELACIONADOS

Una factura puede tener varios documentos relacionados como: Nota crédito y Nota débito.
1. Hacer clic en Emitir 6 -consultar documentos relacionados.

2. Clic en Try it.
82


83
7.2.7.3 CONSULTAR DOCUMENTOS ENVIADOS A LA DIAN

Todos los documentos emitidos como factura, nota crédito y nota debito deben ser enviados a la DIAN y para saber
si estos fueron enviados PLcolab le brinda una consulta donde indica los documentos que se entregaron a la DIAN.
1. Hacer clic en Emitir 7- consultar envió DIAN.

2. Clic en Try it.
84
5. Hacer clic en Send. Si la solicitud es exitosa, el sistema responde (200 OK).

7.2.7.4 CONSULTAR ACEPTACIÓN/RECHAZO DEL DOCUMENTO
Mediante esta API se puede consultar los documentos que se encuentran en estados Aceptado o rechazado.
6. Hacer clic en Emitir 3 –consultar Aceptación/Rechazo.

85
7. Clic en Try it.
8. Digitar el LDF del documento emitido.

9. Hacer clic en Add header, digitar Authorization y pegar el token anteponiendo la palabra Bearer
10. Hacemos clic en Send. Si la solicitud es exitosa, el sistema responde (200 OK).
86
7.2.7.5 LISTAR DOCUMENTOS EMITIDOS

Por medio de una API se puede listar la información de los documentos emitidos.
1. Si se desea consultar las facturas emitidas, se debe ingresar a la consulta de documentos. En una
nueva pestaña, hacer clic en el módulo PRODUCT y luego en [plcolab-pre] Emisión.
2. Hacer clic en Documents.
87
3. Hacer clic en Listar Documentos Emitidos.

4. Clic en el botón Try it.
5. Se envía como Query Parameter el pageIndex (número de la página sobre la cual se hará el listado)
y el pageSize (número de documentos a listar en la página señalada). Como parámetro de cabecera
se envía el token de autorización (anteponiendo al token, la palabra “Bearer”); Finalmente, para
ejecutar la petición, hacer clic en el botón Send.
88
6. Una vez realizada la consulta, el sistema debe mostrar 200 OK como respuesta exitosa, listando el
número de documentos emitidos a mostrar (pageSize).
89
4. Para consultar el estado del documento se realiza lo siguiente:

1. Hacer clic en Estado documento.
2. Clic en Try it.
90
3. Digitamos el LDF del documento registrado.


91
7.2.7.6 CONSULTAR DOCUMENTO RELACIONADO A UN LDF
Una factura puede tener varios documentos relacionados como: Nota crédito y Nota débito los cuales se pueden
consultar por el LDF que arroja al momento de la emisión.
1. Hacer clic en Relations By LDF. 92

2. Clic en Try it.

4. Se debe digitar la página y el tamaño en pageIndex y pageSize.

93
7.2.7.7 CONSULTAR EL BINARIO DE UN DOCUMENTO

Plcolab permite por medio de API obtener el binario de los documentos emitidos.
1. Hacer clic en Binary by LDF.

2. Clic en Try it.
94


95
4. Para consultar el XML de un documento se realiza lo siguiente:

1. Hacer clic en XML By LDF.
2. Clic en Try it.
96


97

Documentacion Tecnica API ManagementV3

Cargado por

Información del documento

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Documentacion Tecnica API ManagementV3

Cargado por

Copyright:

Formatos disponibles

PL-Colab

1.0 15/09/2016 Manuel Segrera Creación del documento

1.2 10/05/2017 Eneida Edinson Actualización de documento.

1.3 21/06/2017 Deimer Olea Actualización de documento.

1.4 10/07/2017 German Zabaleta Actualización de documento Coordenadas

1.5 23/11/2017 German Zabaleta Actualización de documento.

4.2 ACTUALIZAR TOKEN DE SEGURIDAD..............................................................................................................9

5. CONVENCIONES GENERALES ...............................................................................................................................12

5.1 MENÚ PRINCIPAL .........................................................................................................................................12

5.2 ACCEDER/CONSULTAR API ...........................................................................................................................13

5.2.1 SECCIÓN 1: BANDA VERTICAL PANEL IZQUIERDO..................................................................................14

5.2.2 SECCIÓN 2: NOMBRE Y DESCRIPCIÓN DEL MÉTODO O API ...................................................................14

5.2.3 SECCIÓN 3: PARÁMETROS .....................................................................................................................14

5.2.4 SECCIÓN 4: ENCABEZADO DE LA SOLICITUD ..........................................................................................15

5.2.5 SECCIÓN 5: CUERPO DE LA SOLICITUD ..................................................................................................15

5.2.6 SECCIÓN 6: EJEMPLOS DE CÓDIGO ........................................................................................................15

5.2.7 SECCIÓN 7: TRY IT / AUTENTICACIÓN EN LA API ...................................................................................16

5.2.8 SEND ......................................................................................................................................................16

6. AUTENTICACIÓN PORTAL API ..............................................................................................................................17

6.1 INICIAR SESIÓN ............................................................................................................................................18

6.2 SELECCIONAR EL PRODUCTO A UTILIZAR ....................................................................................................19

6.3 SELECCIONAR LA OPCIÓN DE AUTORIZACIÓN .............................................................................................19

6.3.1 IMPERSONACION ...................................................................................................................................23

6.3.2 IMPERSONACION CON TOKEN DE SEGURIDAD .....................................................................................26

7. API DISPONIBLES ..................................................................................................................................................29

7.1 RESUMEN DE PRODUCTO PARA LA EMISIÓN (PRODUCTOS/EMISIÓN) .......................................................29

7.2 DETALLE DE LAS API PARA EMISIÓN ............................................................................................................31

7.2.1 SUCURSALES ..........................................................................................................................................31

7.2.2 PROCESOS O CENTROS DE COSTOS .......................................................................................................43

7.2.3 FOLIOS O NUMERACIONES ....................................................................................................................54

7.2.5 EMISIÓN DE DOCUMENTOS ...................................................................................................................69

7.2.7 CONSULTAS RELACIONADAS A UN DOCUMENTO .................................................................................79

Entre las ventajas de este mecanismo se encuentran:

• La documentación de la API se encuentra siempre disponible y actualizada ya que la fuente de la misma es

• https://plcolab-api-portal-sandbox.facture.co : Portal para clientes que se encuentran realizando pruebas

1. Hacer clic en Regístrese ahora.

2. Ingresar la información solicitada en el formulario.

3. Hacer clic en Registrarse.

A partir de éste momento el cliente está en capacidad de ingresar al portal.

El siguiente paso consiste en crear el token de seguridad.

En el cuerpo de la solicitud, se encuentra el siguiente formulario:

4.2 ACTUALIZAR TOKEN DE SEGURIDAD

El siguiente paso consiste en Actualizar un token de seguridad.

En el cuerpo de la solicitud, se encuentra el siguiente formulario:

Luego se envía la petición mediante el uso del botón “Send”.

5.1 MENÚ PRINCIPAL

3. APPLICATIONS: Esta sección no está disponible.

4. ISSUES: Por medio de ésta sección el cliente puede “notificar problemas”.

• Blanco: método actualmente seleccionado PUT.

GET: Utilizado para consultar y leer recursos.

POST: Utilizado para crear recursos.

PUT: Utilizado para editar recursos.

DELETE: Utilizado para eliminar recursos.

5.2.2 SECCIÓN 2: NOMBRE Y DESCRIPCIÓN DEL MÉTODO O API

5.2.3 SECCIÓN 3: PARÁMETROS

5.2.5 SECCIÓN 5: CUERPO DE LA SOLICITUD

5.2.6 SECCIÓN 6: EJEMPLOS DE CÓDIGO

1. Hacer clic en Add header

*Nota: A continuación, se mencionan algunos códigos

1- Los códigos de estado 2XX (Correcto)

2. Sección 7: Corresponde a un resumen con detalles del error, fecha, etc.

6. AUTENTICACIÓN PORTAL API

6.3 SELECCIONAR LA OPCIÓN DE AUTORIZACIÓN

En el cuerpo de la solicitud, se encuentra el siguiente formulario: