¿Cómo obtener un Proveedor por medio de una API?

API
, , ,
1

Esta entrada posee información técnica sobre la API especificada y está dirigido a clientes que busquen integrar el Maestro de Proveedores con otro sistema.

Pasos a seguir:

1. Obtención de token

Antes de cada solicitud se debe obtener el token de autorización, en función de las credenciales de un usuario API creado en el maestro Usuarios.

Se utiliza para generar un token de autenticación que permite poder consumir una API de Finnegans.

2. Métodos de recuperación y envío de datos a un servidor:

GET

URL:

https://api.finneg.com/api/proveedor/{codigo}?ACCESS_TOKEN={$access_token}

Parámetros:

  • ACCESS_TOKEN: Requerido. Ejemplo: “a0e172d4-e070-4346-96fa-c02a97230384”.
  • {codigo} Es el Código del registro en el maestro Proveedores.

Códigos de respuesta:

  • 200 Ok: Se devuelve la información del Proveedor.
  • 404 Solicitud incorrecta: { “error”: "Not Found: ", “status”: 404 }.
  • 500 Error interno de servidor: { “error”: “Internal Server Error: null”,“status”: 500}.

JSON proveedor

{
   "Nombre": " EMPRESA PROVINCIAL DE ENERGIA DE CORDOBA",
   "Codigo": "4249",
   "Activo": true,
   "RazonSocial": " EMPRESA PROVINCIAL DE ENERGIA DE CORDOBA",
   "Descripcion": "",
   "Email": "",
   "CategoriaFiscalCodigo": "RI",
   "IdentificacionTributariaCodigo": "CUIT",
   "IdentificacionTributariaNumero": "30-99902748-9",
   "EsCliente": false,
   "PaginaWeb": "",
   "EsContratista": false,
   "SituacionIIBB": 0,
   "NroInscripcionIIBB": "",
   "CategoriaSIAP": 0,
   "BancoCodigo": null,
   "ClaveBancaria": "",
   "CuentaBancoTipo": 0,
   "NumeroCuenta": "",
   "RestriccionCondPagos": false,
   "CondicionesPago": [],
   "Contactos": [],
   "Direcciones": [],
   "Telefonos": [],
   "Percepciones": [],
   "ProvinciaItems": [],
   "ConceptoProveedorCodigo": "PROV",
   "CuentaProveedorCodigo": "2212112111.001",
   "EsMultipay": false,
   "EsCorredor": false,
   "SucursalBanco": "",
   "CantEmpleados": null,
   "CantEmpleadosRango": null,
   "IngresosAnuales": 0.0,
   "tamano": null,
   "EsTransportista": false,
   "EsChofer": false,
   "BeneficiarioCheque": "",
   "EsApocrifo": false,
   "ConstanciaInscripcionAfip": "",
   "FechaSolicitada": "2024-02-02",
   "FechaVencimientoConstanciaInscripcionAFIP": "2024-02-02",
   "EsOrganizacionUTE": false,
   "ExportaDataNet": false,
   "FechaAlta": "2024-02-02 13:39:17.987",
   "OrganizacionImagen": "",
   "EsSincronizarGmap": false,
   "MotivoBaja": 0,
   "FechaConstitucion": "2024-02-02",
   "IdentTributariaPaisOrigen": "",
   "UtilizaPisoPallet": false,
   "DiasMaximoValores": null,
   "VolumenMinimo": null,
   "ImporteMinimo": null,
   "ControlValores": null,
   "TipoPersona": 0,
   "CuentaID_Pago_Codigo": null,
   "OperacionBancariaID_Pago_Codigo": null,
   "MonedaID_Pago_Codigo": null,
   "Originacion_Codigo": null,
   "UsoComprobante_Codigo": null,
   "ListaPrecioIDDefault_Codigo": null,
   "UsuarioIDAlta_Codigo": "SUPERVISOR",
   "Vendedor_Codigo": null,
   "ProductoDefault_Codigo": null,
   "CentroCostoDefault_Codigo": null,
   "Pais_Codigo": null,
   "Provincia_Codigo": null,
   "Localidad_Codigo": null,
   "Mercado_Codigo": null,
   "ActividadIVA_Codigo": null,
   "Situacion_IIBB": 0
}

POST

URL:

https://api.finneg.com/api/proveedor?ACCESS_TOKEN={$access_token}

Parámetros:

  • ACCESS_TOKEN: Requerido. Ejemplo: “a0e172d4-e070-4346-96fa-c02a97230384”.

Se detalla la estructura del JSON a enviar y las características de cada atributo.

Códigos de respuesta:

  • 200 Ok: Se devuelve el id de proveedor, un mensaje informando que se creó correctamente y el código de estado de la respuesta. Ejemplo: {
    “id”: “358e63c1cf9a0a36161aec8c49a341e3d031e34d”,
    “message”: “created”,
    “status”: 200
    }

  • 404 Solicitud incorrecta: { “error”: "Not Found: ", “status”: 404 }.

  • 500 Error interno de servidor: { “error”: “Internal Server Error: null”,“status”: 500}.

PUT

URL:

https://api.finneg.com/api/proveedor/{codigo}?ACCESS_TOKEN={$access_token}

Parámetros:

  • ACCESS_TOKEN: Requerido. Ejemplo: “a0e172d4-e070-4346-96fa-c02a97230384”.
  • {codigo} Es el Código del registro en el maestro Proveedores.

Códigos de respuesta:

  • 200 Ok: Se devuelve un mensaje informando que se actualizó correctamente y el código de estado de respuesta. Ejemplo: {
    “message”: “updated”,
    “status”: 200
    }

  • 404 Solicitud incorrecta: { “error”: "Not Found: ", “status”: 404 }.

  • 500 Error interno de servidor: { “error”: “Internal Server Error: null”,“status”: 500}.

DELETE

URL: https://api.finneg.com/api/proveedor/{codigo}?ACCESS_TOKEN={$access_token}

Parámetros:

  • ACCESS_TOKEN: Requerido. Ejemplo: “a0e172d4-e070-4346-96fa-c02a97230384”.
  • {codigo} Es el Código del registro en el maestro Proveedores.

Códigos de respuesta:

  • 200 Ok: Se devuelve un mensaje informando que se eliminó correctamente y código de estado de respuesta. Ejemplo: {
    “message”: “deleted”,
    “status”: 200
    }

  • 404 Solicitud incorrecta: { “error”: "Not Found: ", “status”: 404 }.

  • 500 Error interno de servidor: { “error”: “Internal Server Error: null”,“status”: 500}.

Antes de empezar

Antes de utilizar esta API, se deben considerar algunas cuestiones que se detallan a continuación.

Definición de API

Dentro de la API en el Diccionario de APIs debe estar la información configurada de acuerdo a lo que se detalla:

  • En la solapa Definición debe indicarse todos los campos que tiene el JSON indicado más arriba.
  • En el campo Tipo debe estar el valor Entidad.
  • En el campo Entidad debe indicarse Proveedor.