Servicio Api REST [ FIRMA ELECTRONICA SAT ]

Sección General

Url
http://apisnet.col.gob.mx/wsSignGob/apiV1/{acción}/{método}/{parámetros}
Estructura de respuesta
RESTService
StatusCode
Código de estado de la petición [ 1 = Exito, 0 = Error ]
StatusResponse
Estado de la respuesta [ EXITO, ERROR ]
Message
Mensaje de respuesta
Fecha
Fecha de la petición DD/MM/AAAA
Hora
Hera de la petición HH:MM:SS
ResponseKey
GUID de respuesta
ResponseTime
Tiempo de respuesta de la petición
Response
Estructura dinámica con los datos solicitados

Sección Consulta

Nombre del método Status

Método de Envío
GET
Descripción
Verificar el estado el servicio API REST
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Status
Ejemplo
Status

Nombre del método FirElInstaller

Método de Envío
GET
Descripción
Descargar archivo de instalación del aplicativo de escritorio FirEl
Parámetros1
version
Descripción
Número de versión del aplicatiovo [ Ej. 1.0.1 ], si se omite descargará la ultima versión estable liberada.
Formato
Texto
Configuración
Url parameter [ url?version={value} ]
Tipo de parámetro
opcional
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Download/FirelApplication
Ejemplo
FirElInstaller

Nombre del método Valida / Certificado

Método de Envío
POST
Descripción
Verificar el estado del certificado .cer
Configuración
Envío de petición [ form-data ]
Parámetros1
certificado
Descripción
Archivo .cer del certificado público
Formato
Archivo
Configuración
File form-data
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Valida/Certificado

Nombre del método Valida / Firma [ Certificado ]

Método de Envío
POST
Descripción
Verificar la firma electrónica
Configuración
Envío de petición [ form-data ]
Parámetros3
cadenaOriginal
Descripción
cadena de texto original que fué firmada
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ cadenaOriginal={value} ]
Tipo de parámetro
Obligatorio
firma
Descripción
cadena de texto correspondiente a la firma electrónica
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ firma={value} ]
Tipo de parámetro
Obligatorio
certificado
Descripción
Archivo .cer del certificado público
Formato
Archivo
Configuración
File form-data
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Valida/Firma

Nombre del método Valida / Firma [ Serial del Certificado ]

Método de Envío
POST
Descripción
Verificar la firma electrónica
Parámetros3
cadenaOriginal
Descripción
cadena de texto original que fué firmada
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ cadenaOriginal={value} ]
Tipo de parámetro
Obligatorio
firma
Descripción
cadena de texto correspondiente a la firma electrónica
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ firma={value} ]
Tipo de parámetro
Obligatorio
serialCertificado
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ serialCertificado={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Valida/Firma

Nombre del método Obtener / Evidencia

Método de Envío
GET
Descripción
Obtener evidencia firmada
Parámetros2
secuencia
Descripción
Número de secuencia de validación
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?secuencia={value} ]
Tipo de parámetro
Obligatorio
validador
Descripción
Folio validador
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?validador={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/Evidencia

Nombre del método Obtener / InforArchivoEvidencia

Método de Envío
GET
Descripción
Obtener información del archivo de evidencia firmada
Parámetros1
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/InfoArchivoEvidencia

Nombre del método Obtener / ArchivoEvidencia

Método de Envío
GET
Descripción
Obtener archivo de evidencia firmada
Parámetros1
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/ArchivoEvidencia

Nombre del método Obtener / Evidencias

Método de Envío
GET
Descripción
Obtener evidencias firmadas por serial del certificado
Parámetros1
serialCertificado
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serialCertificado={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/Evidencias

Nombre del método Obtener / EvidenciaQr

Método de Envío
GET
Descripción
Obtener evidencia firmada en código Qr
Parámetros2
secuencia
Descripción
Número de secuencia de validación
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?secuencia={value} ]
Tipo de parámetro
Obligatorio
validador
Descripción
Folio validador
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?validador={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/EvidenciaQr

Nombre del método Obtener / Certificado

Método de Envío
GET
Descripción
Obtener certificado público
Parámetros1
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/Certificado

Nombre del método Obtener / Tocken

Método de Envío
GET
Descripción
Obtener información del tocken
Parámetros2
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/Tocken

Nombre del método Obtener / Tockens

Método de Envío
GET
Descripción
Obtener lista del tockens por firmar
Parámetros1
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/Tockens

Nombre del método Obtener / Tocken / AuthForm

Método de Envío
GET
Descripción
Obtener información del tocken de autenticación
Parámetros2
Tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?Tocken={value} ]
Tipo de parámetro
Obligatorio
DataRef
Descripción
Identificador único de referencia
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?DataRef={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Obtener/AuthFormTocken

Nombre del método Calcular / MD5

Método de Envío
POST
Descripción
Calcular MD5 de archivo
Configuración
Envío de petición [ form-data ]
Parámetros1
archivo
Descripción
Archivo que se desea calcular su MD5
Formato
Archivo
Configuración
File form-data
Tipo de parámetro
Obligatorio
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Calcular/MD5

Sección Insertar

Nombre del método Guardar / Evidencia

Método de Envío
PUT
Descripción
Guardar evidencia
Configuración
Envío de petición [ form-data ]
Parámetros4
cadenaOriginal
Descripción
Cadena original
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ cadenaOriginal={value} ]
Tipo de parámetro
Obligatorio
firma
Descripción
Cadena de firma
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ firma={value} ]
Tipo de parámetro
Obligatorio
validador
Descripción
Dato validador
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ validador={value} ]
Tipo de parámetro
Obligatorio
certificado
Descripción
Archivo .cer del certificado público
Formato
Archivo
Configuración
File form-data
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Guardar/Evidencia

Nombre del método Generar / Tocken

Método de Envío
PUT
Descripción
Generar tocken de firma
Configuración
Envío de petición [ x-www-form-urlencoded ]
Parámetros3
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
x-www-form-urlencoded [ serial={value} ]
Tipo de parámetro
Obligatorio
cadenaOriginal
Descripción
Cadena original
Estructura
Formato
cadena de texto alfanumérica en formato JSON
JSON
{ "ToSign" : { "Data" : "|Dato1|Dato2|Dato3|...|DatoN|", "MIMEType" : "text/plain [ Ver Media Types ]", "Charset" : "UTF-8, iso-8859-1, etc. [ Ver Character Sets ]", "Base64Encode" : "True o False" }, "Validator" : "Cadena alfanumérica [ Dato validador para el portal de evidencia ]" }
Documentación soporte
Media Types, Character Sets
Configuración
x-www-form-urlencoded [ cadenaOriginal={value} ]
Tipo de parámetro
Obligatorio
descripcionDocumento
Descripción
Desripción del documento
Formato
cadena de texto
Configuración
x-www-form-urlencoded [ descripcionDocumento={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Generar/Tocken

Nombre del método Generar / Tocken / File

Método de Envío
PUT
Descripción
Generar tocken de firma de contenido
Configuración
Envío de petición [ form-data ]
Parámetros4
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
form-data [ serial={value} ]
Tipo de parámetro
Obligatorio
cadenaOriginal
Descripción
Cadena original
Estructura
Formato
cadena de texto alfanumérica en formato JSON
JSON
{ "ToSign" : { "Data" : "|Dato1|Dato2|Dato3|...|DatoN|","Charset" : "UTF-8, iso-8859-1, etc. [ Ver Character Sets ]","MIMEType" : "application/pdf, image/jpeg, image/png, etc. [ Ver Media Types ]","FileInfo" : { "MD5CheckSum" : "Cadena alfanumérica de 32 dígitos [ Ej. 3d7720f8e7d7a7c249dfbef87f438b04 ] [ Ver md5sum ] "} },"Validator" : "Cadena alfanumérica [ Dato validador para el portal de evidencia ]"}
Documentación soporte
Media Types, Character Sets, md5sum
Configuración
form-data [ cadenaOriginal={value} ]
Tipo de parámetro
Obligatorio
descripcionDocumento
Descripción
Desripción del documento
Formato
cadena de texto
Configuración
form-data [ descripcionDocumento={value} ]
Tipo de parámetro
Obligatorio
archivo
Descripción
Archivo de contenido
Formato
Archivo
Configuración
File form-data [ descripcionDocumento={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Generar/Tocken/Archivo

Nombre del método Generar / Tocken / Auth

Método de Envío
PUT
Descripción
Generar tocken para autenticación
Configuración
Envío de petición [ x-www-form-urlencoded ]
Parámetros1
DataRef
Descripción
Identificador único de referencia
Formato
cadena de texto alfanuérica
Configuración
x-www-form-urlencoded [ DataRef={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Generar/Tocken/AuthForm

Nombre del método Marcar / Tocken

Método de Envío
PUT
Descripción
Vincular tocken a evidencia firmada
Parámetros3
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
secuencia
Descripción
Número de secuencia de validación
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?secuencia={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Marcar/Tocken

Sección Modificar

Nombre del método Cancelar / Evidencia

Método de Envío
DELETE
Descripción
Cancelar evidencia
Configuración
Envío de petición [ form-data ]
Parámetros3
anioExpedicion
Descripción
Año de expedición de la evidencia
Formato
valor numérico de 4 dígitos
Configuración
Text form-data [ anioExpedicion={value} ]
Tipo de parámetro
Obligatorio
secuencia
Descripción
Número de secuencia
Formato
valor numérico de 6 dígitos de longitud
Configuración
Text form-data [ secuencia={value} ]
Tipo de parámetro
Obligatorio
validador
Descripción
Dato validador
Formato
cadena de texto alfanumérica
Configuración
Text form-data [ validador={value} ]
Tipo de parámetro
Obligatorio
Protegido
Si
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/apiV1/Cancelar/Evidencia

Sección iFrames

Nombre del método Sign V1

URL
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/Sign
Descripción
Firmar electrónicamente en línea
Versión 1
Requiere de previa generación de tocken de firma, en el IFrame se debe incluir los 3 elementos de la FIEL / EFirma [ Certificado público, llave privada y la contraseña ]
Parámetros3
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
forwardURL
Descripción
Url de respuesta
Formato
URI accesible
Configuración
Url parameter [ forwardURL={value} ]
Tipo de parámetro
Opcional
Uso
Al terminar el proceso de firma se invocará la URL de respuesta por POST, se enviarán como parámetros la cadena de firma [ firma ], en número de secuencia de validación [ secuencia ], la cadena original firmada [ cadenaOriginal ] y el serial del certificado con el que se realizó el proceso [ certificadoSerial ]
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/Sign?serial=0000000000000000000000000000000000000000&tocken=00000000-0000-0000-0000-000000000000&forwardURL=http://xxxxxx.xxx:000/xxx/xxx
Ejemplo
Sign V1

Nombre del método Sign V2

URL
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/SignV2
Descripción
Firmar electrónicamente en línea
Versión 2
Requiere de previa generación de tocken de firma, en el IFrame se debe incluir 2 elementos de la FIEL / EFirma [ Llave privada y la contraseña ]
Parámetros3
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
forwardURL
Descripción
Url de respuesta
Formato
URI accesible
Configuración
Url parameter [ forwardURL={value} ]
Tipo de parámetro
Opcional
Uso
Al terminar el proceso de firma se invocará la URL de respuesta por POST, se enviarán como parámetros la cadena de firma [ firma ], en número de secuencia de validación [ secuencia ], la cadena original firmada [ cadenaOriginal ] y el serial del certificado con el que se realizó el proceso [ certificadoSerial ]
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/SignV2?serial=0000000000000000000000000000000000000000&tocken=00000000-0000-0000-0000-000000000000&forwardURL=http://xxxxxx.xxx:000/xxx/xxx
Ejemplo
Sign V2

Nombre del método Sign V3

URL
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/SignV3
Descripción
Firmar electrónicamente en línea
Versión 1
Requiere de previa generación de tocken de firma, en el IFrame se debe incluir los 3 elementos de la FIEL / EFirma [ Certificado público, llave privada y la contraseña ]
Parámetros3
serial
Descripción
Número de serial del certificado
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?serial={value} ]
Tipo de parámetro
Obligatorio
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
forwardURL
Descripción
Url de respuesta
Formato
URI accesible
Configuración
Url parameter [ forwardURL={value} ]
Tipo de parámetro
Opcional
Uso
Al terminar el proceso de firma se invocará la URL de respuesta por POST, se enviarán como parámetros la cadena de firma [ firma ], en número de secuencia de validación [ secuencia ], la cadena original firmada [ cadenaOriginal ] y el serial del certificado con el que se realizó el proceso [ certificadoSerial ]
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/SignV3?serial=0000000000000000000000000000000000000000&tocken=00000000-0000-0000-0000-000000000000&forwardURL=http://xxxxxx.xxx:000/xxx/xxx
Ejemplo
Sign V3

Nombre del método AuthForm V1

URL
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/authForm
Descripción
Formulaio de autenticación utilizando los certificados FIEL / EFirma del SAT
Versión 1
Requiere de previa generación de tocken de autenticación, en el IFrame se debe incluir los 3 elementos de la FIEL / EFirma [ Certificado público, llave privada y la contraseña ]
Parámetros2
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
forwardURL
Descripción
Url de respuesta
Formato
URI accesible
Configuración
Url parameter [ forwardURL={value} ]
Tipo de parámetro
Opcional
Uso
Al terminar el proceso de firma se invocará la URL de respuesta por POST, se enviarán como parámetros la cadena de firma [ firma ], en número de secuencia de validación [ secuencia ], la cadena original firmada [ cadenaOriginal ] y el serial del certificado con el que se realizó el proceso [ certificadoSerial ]
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/authForm?tocken=00000000-0000-0000-0000-000000000000&forwardURL=http://xxxxxx.xxx:000/xxx/xxx
Ejemplo
AuthForm V1

Nombre del método AuthForm V2

URL
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/authFormV2
Descripción
Formulaio de autenticación utilizando los certificados FIEL / EFirma del SAT
Versión 1
Requiere de previa generación de tocken de autenticación, en el IFrame se debe incluir los 3 elementos de la FIEL / EFirma [ Certificado público, llave privada y la contraseña ]
Parámetros2
tocken
Descripción
Número de tocken
Formato
cadena de texto alfanumérica
Configuración
Url parameter [ url?tocken={value} ]
Tipo de parámetro
Obligatorio
forwardURL
Descripción
Url de respuesta
Formato
URI accesible
Configuración
Url parameter [ forwardURL={value} ]
Tipo de parámetro
Opcional
Uso
Al terminar el proceso de firma se invocará la URL de respuesta por POST, se enviarán como parámetros la cadena de firma [ firma ], en número de secuencia de validación [ secuencia ], la cadena original firmada [ cadenaOriginal ] y el serial del certificado con el que se realizó el proceso [ certificadoSerial ]
Protegido
No
Url de invocación
http://apisnet.col.gob.mx/wsSignGob/webV1/iFrame/authFormV2?tocken=00000000-0000-0000-0000-000000000000&forwardURL=http://xxxxxx.xxx:000/xxx/xxx
Ejemplo
AuthForm V2